openshot-audio  0.1.5
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
ImagePixelData Class Referenceabstract

#include <juce_Image.h>

Inheritance diagram for ImagePixelData:
ReferenceCountedObject CoreGraphicsImage SoftwarePixelData SubsectionPixelData WindowsBitmapImage XBitmapImage

Classes

struct  Listener
 

Public Types

typedef ReferenceCountedObjectPtr< ImagePixelDataPtr
 

Public Member Functions

 ImagePixelData (Image::PixelFormat, int width, int height)
 
 ~ImagePixelData ()
 
virtual LowLevelGraphicsContextcreateLowLevelContext ()=0
 
virtual ImagePixelDataclone ()=0
 
virtual ImageTypecreateType () const =0
 
virtual void initialiseBitmapData (Image::BitmapData &, int x, int y, Image::BitmapData::ReadWriteMode)=0
 
virtual int getSharedCount () const noexcept
 
void sendDataChangeMessage ()
 
- Public Member Functions inherited from ReferenceCountedObject
void incReferenceCount () noexcept
 
void decReferenceCount () noexcept
 
bool decReferenceCountWithoutDeleting () noexcept
 
int getReferenceCount () const noexcept
 

Public Attributes

const Image::PixelFormat pixelFormat
 
const int width
 
const int height
 
NamedValueSet userData
 
ListenerList< Listenerlisteners
 

Additional Inherited Members

- Protected Member Functions inherited from ReferenceCountedObject
 ReferenceCountedObject ()
 
virtual ~ReferenceCountedObject ()
 
void resetReferenceCount () noexcept
 

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

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ ImagePixelData()

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

◆ ~ImagePixelData()

ImagePixelData::~ImagePixelData ( )

Member Function Documentation

◆ clone()

virtual ImagePixelData* ImagePixelData::clone ( )
pure virtual

Creates a copy of this image.

Implemented in XBitmapImage, WindowsBitmapImage, SubsectionPixelData, SoftwarePixelData, and CoreGraphicsImage.

◆ createLowLevelContext()

virtual LowLevelGraphicsContext* ImagePixelData::createLowLevelContext ( )
pure virtual

Creates a context that will draw into this image.

Implemented in XBitmapImage, WindowsBitmapImage, SubsectionPixelData, SoftwarePixelData, and CoreGraphicsImage.

◆ createType()

virtual ImageType* ImagePixelData::createType ( ) const
pure virtual

Creates an instance of the type of this image.

Implemented in XBitmapImage, WindowsBitmapImage, SubsectionPixelData, SoftwarePixelData, and CoreGraphicsImage.

◆ getSharedCount()

int 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 SubsectionPixelData.

◆ initialiseBitmapData()

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

Initialises a BitmapData object.

Implemented in XBitmapImage, WindowsBitmapImage, SubsectionPixelData, SoftwarePixelData, and CoreGraphicsImage.

◆ sendDataChangeMessage()

void ImagePixelData::sendDataChangeMessage ( )

Member Data Documentation

◆ height

const int ImagePixelData::height

◆ listeners

ListenerList<Listener> ImagePixelData::listeners

◆ pixelFormat

const Image::PixelFormat ImagePixelData::pixelFormat

The pixel format of the image data.

◆ userData

NamedValueSet ImagePixelData::userData

User-defined settings that are attached to this image.

See also
Image::getProperties().

◆ width

const int ImagePixelData::width

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