Graphics::MemoryImageObject Class Reference

#include <Object.h>

Inheritance diagram for Graphics::MemoryImageObject:

Collaboration diagram for Graphics::MemoryImageObject:

Public Member Functions
	MemoryImageObject (PixelFormat format, Size size)
	~MemoryImageObject ()
Surface *	createSurface (const Blend *blend, size_t bufferSize=0)
bool	isValid () const
Size	getSize () const override
	Get target dimensions. More...
PixelFormat	getPixelFormat () const override
	Get native pixel format. More...
Surface *	createSurface (size_t bufferSize=0) override
	Create a surface for use with this render target. More...
Public Member Functions inherited from Graphics::RawImageObject
	RawImageObject (IDataSourceStream *image, PixelFormat format, Size size)
	RawImageObject (const FSTR::String &image, PixelFormat format, Size size)
	RawImageObject (const Resource::ImageResource &image)
void	write (MetaWriter &meta) const override
bool	init () override
	Initialise the object, e.g. parse header content and obtain dimensions. More...
size_t	readPixels (const Location &loc, PixelFormat format, void *buffer, uint16_t width) const override
	Read pixels in requested format. More...
Public Member Functions inherited from Graphics::StreamImageObject
	StreamImageObject (IDataSourceStream *source, Size size)
	StreamImageObject (const FSTR::String &image)
Public Member Functions inherited from Graphics::ImageObject
	ImageObject (Size size)
Renderer *	createRenderer (const Location &location) const override
	Create a software renderer for this object. More...
Size	getSize () const
uint16_t	width () const
uint16_t	height () const
Public Member Functions inherited from Graphics::ObjectTemplate< Object::Kind::Image >
Kind	kind () const override
Public Member Functions inherited from Graphics::Object
bool	operator== (const Object &other) const
virtual String	getTypeStr () const
Public Member Functions inherited from LinkedObjectTemplate< Object >
Object *	getNext () const
bool	insertAfter (Object *object)
Iterator	begin () const
Iterator	end () const
Iterator	cbegin () const
Iterator	cend () const
Public Member Functions inherited from LinkedObject
virtual	~LinkedObject ()=default
virtual LinkedObject *	next () const
bool	insertAfter (LinkedObject *object)
bool	operator== (const LinkedObject &other) const
bool	operator!= (const LinkedObject &other) const
Public Member Functions inherited from Graphics::RenderTarget
virtual	~RenderTarget ()
PackedColor	getColor (Color color) const

Additional Inherited Members
Public Types inherited from Graphics::Object
enum class	Kind { XX }
using	List = LinkedObjectListTemplate< Object >
using	OwnedList = OwnedLinkedObjectListTemplate< Object >
Public Types inherited from LinkedObjectTemplate< Object >
using	Iterator = IteratorTemplate< Object, Object *, Object & >
using	ConstIterator = IteratorTemplate< const Object, const Object *, const Object & >
Protected Member Functions inherited from Graphics::StreamImageObject
void	seek (uint32_t offset) const
void	read (void *buffer, size_t length) const
Protected Attributes inherited from Graphics::RawImageObject
PixelFormat	pixelFormat
Protected Attributes inherited from Graphics::StreamImageObject
std::unique_ptr< IDataSourceStream >	stream
uint32_t	streamPos {}
Protected Attributes inherited from Graphics::ImageObject
Size	imageSize {}

Constructor & Destructor Documentation

MemoryImageObject()

Graphics::MemoryImageObject::MemoryImageObject	(	PixelFormat	format,
		Size	size
	)

~MemoryImageObject()

Graphics::MemoryImageObject::~MemoryImageObject ( )

inline

Member Function Documentation

createSurface() [1/2]

Surface* Graphics::MemoryImageObject::createSurface	(	const Blend *	blend,
		size_t	bufferSize = 0
	)

createSurface() [2/2]

Surface* Graphics::MemoryImageObject::createSurface ( size_t  bufferSize = 0 )

inlineoverridevirtual

Create a surface for use with this render target.

Parameters

bufferSize

Size of internal command/data buffer

Return values

Surface*

The surface to use

Caller is responsible for destroying the surface when no longer required.

Implements Graphics::RenderTarget.

getPixelFormat()

PixelFormat Graphics::MemoryImageObject::getPixelFormat ( ) const

inlineoverridevirtual

Get native pixel format.

Return values

PixelFormat

Return None if ambivalent about format (e.g. calculated pixel data)

Reimplemented from Graphics::RawImageObject.

getSize()

Size Graphics::MemoryImageObject::getSize ( ) const

inlineoverridevirtual

Get target dimensions.

Implements Graphics::RenderTarget.

isValid()

bool Graphics::MemoryImageObject::isValid ( ) const

inline

---

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

• Libraries/Graphics/src/include/Graphics/Object.h