gamp::render::pixel::PixelRectangle Class Reference

Pixel Rectangle identified by it's hashCode(). More...

#include <PixelFormat.hpp>

Inheritance diagram for gamp::render::pixel::PixelRectangle:

Collaboration diagram for gamp::render::pixel::PixelRectangle:

Public Member Functions
	~PixelRectangle () noexcept=default
virtual const PixelFormat &	format () const noexcept=0
	Returns the PixelFormat.
virtual size_t	hashCode () const noexcept=0
virtual bool	isGLOriented () const noexcept=0
	Returns true if the memory is laid out in OpenGL's coordinate system, origin at bottom left.
virtual uint8_t *	mutablePixels () noexcept=0
	Returns the pixels, mutable.
virtual const uint8_t *	pixels () const noexcept=0
	Returns the pixels.
virtual const Point2u32 &	size () const noexcept=0
	Returns the size, i.e.
virtual uint32_t	stride () const noexcept=0
	Returns stride in byte-size, i.e.
virtual std::string	toString () const =0

Detailed Description

Pixel Rectangle identified by it's hashCode().

The getPixels() are assumed to be immutable.

Definition at line 264 of file PixelFormat.hpp.

Constructor & Destructor Documentation

~PixelRectangle()

gamp::render::pixel::PixelRectangle::~PixelRectangle ( )

defaultnoexcept

Member Function Documentation

hashCode()

virtual size_t gamp::render::pixel::PixelRectangle::hashCode ( ) const

pure virtualnoexcept

Computes a hash code over:

• pixelformat
• size
• stride
• isGLOriented
• pixels

The hashCode shall be computed only once with first call and stored for later retrieval to enhance performance.

Implemented in gamp::render::pixel::GenericPixelRect.

Here is the caller graph for this function:

format()

virtual const PixelFormat & gamp::render::pixel::PixelRectangle::format ( ) const

pure virtualnoexcept

Returns the PixelFormat.

Implemented in gamp::render::pixel::GenericPixelRect.

Here is the caller graph for this function:

size()

virtual const Point2u32 & gamp::render::pixel::PixelRectangle::size ( ) const

pure virtualnoexcept

Returns the size, i.e.

width and height.

Implemented in gamp::render::pixel::GenericPixelRect.

Here is the caller graph for this function:

stride()

virtual uint32_t gamp::render::pixel::PixelRectangle::stride ( ) const

pure virtualnoexcept

Returns stride in byte-size, i.e.

byte count from one line to the next.

Must be >= getPixelformat().bytesPerPixel() * getSize().getWidth().

Implemented in gamp::render::pixel::GenericPixelRect.

Here is the caller graph for this function:

isGLOriented()

virtual bool gamp::render::pixel::PixelRectangle::isGLOriented ( ) const

pure virtualnoexcept

Returns true if the memory is laid out in OpenGL's coordinate system, origin at bottom left.

Otherwise returns false, i.e. origin at top left.

Implemented in gamp::render::pixel::GenericPixelRect.

Here is the caller graph for this function:

pixels()

virtual const uint8_t * gamp::render::pixel::PixelRectangle::pixels ( ) const

pure virtualnoexcept

Returns the pixels.

Implemented in gamp::render::pixel::GenericPixelRect.

Here is the caller graph for this function:

mutablePixels()

virtual uint8_t * gamp::render::pixel::PixelRectangle::mutablePixels ( )

pure virtualnoexcept

Returns the pixels, mutable.

Implemented in gamp::render::pixel::GenericPixelRect.

Here is the caller graph for this function:

toString()

virtual std::string gamp::render::pixel::PixelRectangle::toString ( ) const

pure virtual

Implemented in gamp::render::pixel::GenericPixelRect.

Here is the caller graph for this function:

---

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

• include/gamp/render/pixel/PixelFormat.hpp