ui::CompressedTransparencyMap Struct Reference

A basic image that is a single color when not transparent. More...

#include <compressed_transparency_map.hpp>

Inheritance diagram for ui::CompressedTransparencyMap:

Public Member Functions
void	renderAt (const Coords &coords, const shader_t &shader=0) const override
	Display the image directly onto the screen.
	TransparencyMap (const Size &size, color_t color, uint8_t *const mask)
	Construct a transparency map image from static data.
Public Member Functions inherited from ui::TransparencyMap
	TransparencyMap (const Size &size, color_t color, uint8_t *const mask)
	Construct a transparency map image from static data.
Size	getSize () const override
	Get the size of the transparency map.
void	renderAt (const Coords &coords, const shader_t &shader=0) const override
	Display the image directly onto the screen.

Additional Inherited Members
Public Attributes inherited from ui::TransparencyMap
Size	size
	The size of the image in pixels.
color_t	color
	The color of non-transparent pixels.
uint8_t *const	mask
	The transparency mask.

Detailed Description

A basic image that is a single color when not transparent.

Member Function Documentation

renderAt()

void ui::CompressedTransparencyMap::renderAt ( const Coords &  coords, const shader_t &  shader = 0  ) const

overridevirtual

Display the image directly onto the screen.

Parameters

coords	The coordinages to render the first pixel [0,0] of the transparency map.
shader	An optional pixel shader to apply to each pixel of the transparency map.

Note

Shaders will only be applied to non-transparent pixels.

Implements ui::Renderable.

TransparencyMap()

ui::TransparencyMap::TransparencyMap	(	const Size &	size,
		color_t	color,
		uint8_t *const	mask
	)

Construct a transparency map image from static data.

Parameters

size	The size of the image.
color	The color of non-transparent pixels.
mask	The transparency mask for the image.

---

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

• src/ui/core/renderable/bitmap/compressed_transparency_map.hpp