juce::ImagePixelData Class Reference

This is a base class for holding image data in implementation-specific ways. More...

#include "juce_Image.h"

Inheritance diagram for juce::ImagePixelData:

Classes
struct	Listener
	Used to receive callbacks for image data changes. More...

Public Types
using	Ptr = ReferenceCountedObjectPtr< ImagePixelData >

Public Member Functions
	ImagePixelData (Image::PixelFormat, int width, int height)
virtual std::unique_ptr< LowLevelGraphicsContext >	createLowLevelContext ()=0
	Creates a context that will draw into this image.
virtual Ptr	clone ()=0
	Creates a copy of this image.
virtual std::unique_ptr< ImageType >	createType () const =0
	Creates an instance of the type of this image.
virtual void	initialiseBitmapData (Image::BitmapData &, int x, int y, Image::BitmapData::ReadWriteMode)=0
	Initialises a BitmapData object.
virtual int	getSharedCount () const noexcept
	Returns the number of Image objects which are currently referring to the same internal shared image data.
void	sendDataChangeMessage ()
Public Member Functions inherited from juce::ReferenceCountedObject
void	incReferenceCount () noexcept
	Increments the object's reference count.
void	decReferenceCount () noexcept
	Decreases the object's reference count.
bool	decReferenceCountWithoutDeleting () noexcept
	Decreases the object's reference count.
int	getReferenceCount () const noexcept
	Returns the object's current reference count.

Public Attributes
const Image::PixelFormat	pixelFormat
	The pixel format of the image data.
const int	width
const int	height
NamedValueSet	userData
	User-defined settings that are attached to this image.
ListenerList< Listener >	listeners

Additional Inherited Members
Protected Member Functions inherited from juce::ReferenceCountedObject
	ReferenceCountedObject ()=default
	Creates the reference-counted object (with an initial ref count of zero).
	ReferenceCountedObject (const ReferenceCountedObject &) noexcept
	Copying from another object does not affect this one's reference-count.
	ReferenceCountedObject (ReferenceCountedObject &&) noexcept
	Copying from another object does not affect this one's reference-count.
ReferenceCountedObject &	operator= (const ReferenceCountedObject &) noexcept
	Copying from another object does not affect this one's reference-count.
ReferenceCountedObject &	operator= (ReferenceCountedObject &&) noexcept
	Copying from another object does not affect this one's reference-count.
virtual	~ReferenceCountedObject ()
	Destructor.
void	resetReferenceCount () noexcept
	Resets the reference count to zero without deleting the object.

Detailed Description

This is a base class for holding image data in implementation-specific ways.

You may never need to use this class directly - it's used internally by the Image class to store the actual image data. To access pixel data directly, you should use Image::BitmapData rather than this class.

ImagePixelData objects are created indirectly, by subclasses of ImageType.

See also

Image, ImageType

@tags{Graphics}

Definition at line 445 of file juce_Image.h.

Member Typedef Documentation

Ptr

using juce::ImagePixelData::Ptr = ReferenceCountedObjectPtr<ImagePixelData>

Definition at line 451 of file juce_Image.h.

Constructor & Destructor Documentation

ImagePixelData()

juce::ImagePixelData::ImagePixelData	(	Image::PixelFormat	format,
		int	width,
		int	height
	)

Definition at line 29 of file juce_Image.cpp.

~ImagePixelData()

juce::ImagePixelData::~ImagePixelData ( )

override

Definition at line 36 of file juce_Image.cpp.

Member Function Documentation

clone()

virtual Ptr juce::ImagePixelData::clone ( )

pure virtual

Creates a copy of this image.

Implemented in juce::SoftwarePixelData, juce::SubsectionPixelData, and juce::XBitmapImage.

createLowLevelContext()

virtual std::unique_ptr< LowLevelGraphicsContext > juce::ImagePixelData::createLowLevelContext ( )

pure virtual

Creates a context that will draw into this image.

Implemented in juce::SoftwarePixelData, juce::SubsectionPixelData, and juce::XBitmapImage.

createType()

virtual std::unique_ptr< ImageType > juce::ImagePixelData::createType ( ) const

pure virtual

Creates an instance of the type of this image.

Implemented in juce::SoftwarePixelData, juce::SubsectionPixelData, and juce::XBitmapImage.

getSharedCount()

int juce::ImagePixelData::getSharedCount ( ) const

virtualnoexcept

Returns the number of Image objects which are currently referring to the same internal shared image data.

This is different to the reference count as an instance of ImagePixelData can internally depend on another ImagePixelData via it's member variables.

Reimplemented in juce::SubsectionPixelData.

Definition at line 46 of file juce_Image.cpp.

initialiseBitmapData()

virtual void juce::ImagePixelData::initialiseBitmapData ( Image::BitmapData &  , int  x, int  y, Image::BitmapData::ReadWriteMode    )

pure virtual

Initialises a BitmapData object.

Implemented in juce::SoftwarePixelData, juce::SubsectionPixelData, and juce::XBitmapImage.

sendDataChangeMessage()

void juce::ImagePixelData::sendDataChangeMessage

(

)

Definition at line 41 of file juce_Image.cpp.

Member Data Documentation

height

const int juce::ImagePixelData::height

Definition at line 469 of file juce_Image.h.

listeners

ListenerList<Listener> juce::ImagePixelData::listeners

Definition at line 486 of file juce_Image.h.

pixelFormat

const Image::PixelFormat juce::ImagePixelData::pixelFormat

The pixel format of the image data.

Definition at line 468 of file juce_Image.h.

userData

NamedValueSet juce::ImagePixelData::userData

User-defined settings that are attached to this image.

See also

Image::getProperties().

Definition at line 474 of file juce_Image.h.

width

const int juce::ImagePixelData::width

Definition at line 469 of file juce_Image.h.

---

The documentation for this class was generated from the following files:

• juce_graphics/images/juce_Image.h
• juce_graphics/images/juce_Image.cpp