spk::IconRegion Class Reference

Renders a textured sprite region within a given geometry. More...

#include <spk_icon_region.hpp>

Collaboration diagram for spk::IconRegion:

Public Member Functions
	IconRegion ()
	Builds an empty icon region.
void	setTexture (const spk::SpriteSheet *p_spriteSheet)
	Sets the sprite sheet texture used for the icon.
const spk::SpriteSheet *	texture () const
	Returns the current sprite sheet texture.
void	setSpriteID (const spk::Vector2UInt &p_spriteID)
	Sets the sprite identifier within the sheet.
const spk::Vector2UInt &	spriteID () const
	Returns the current sprite identifier.
void	setGeometry (const spk::Extend2D &p_geometry)
	Sets the geometry used to render the icon.
const spk::Extend2D &	geometry () const
	Returns the current render geometry.
void	setLayer (const float &p_layer)
	Sets the rendering layer.
const float &	layer () const
	Returns the current layer value.
void	render ()
	Renders the icon using the configured texture and geometry.

Detailed Description

Renders a textured sprite region within a given geometry.

See also

SpriteSheet

spk::IconRegion icon;
icon.setTexture(&sheet);
icon.setSpriteID({0, 0});
icon.render();

Member Function Documentation

geometry()

const spk::Extend2D & spk::IconRegion::geometry

(

)

const

Returns the current render geometry.

Returns

Render geometry.

layer()

const float & spk::IconRegion::layer

(

)

const

Returns the current layer value.

Returns

Layer value.

setGeometry()

void spk::IconRegion::setGeometry

(

const spk::Extend2D &

p_geometry

)

Sets the geometry used to render the icon.

Parameters

p_geometry

Render geometry.

setLayer()

void spk::IconRegion::setLayer

(

const float &

p_layer

)

Sets the rendering layer.

Parameters

p_layer

Layer value.

setSpriteID()

void spk::IconRegion::setSpriteID

(

const spk::Vector2UInt &

p_spriteID

)

Sets the sprite identifier within the sheet.

Parameters

p_spriteID

Sprite coordinates in the sheet grid.

setTexture()

void spk::IconRegion::setTexture

(

const spk::SpriteSheet *

p_spriteSheet

)

Sets the sprite sheet texture used for the icon.

Parameters

p_spriteSheet

Sprite sheet to sample.

spriteID()

const spk::Vector2UInt & spk::IconRegion::spriteID

(

)

const

Returns the current sprite identifier.

Returns

Sprite coordinates.

texture()

const spk::SpriteSheet * spk::IconRegion::texture

(

)

const

Returns the current sprite sheet texture.

Returns

Sprite sheet pointer or nullptr.

---

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

• includes/structure/widget/components/spk_icon_region.hpp
• srcs/structure/widget/components/spk_icon_region.cpp