spk::NineSliceBackground Class Reference

Renders a scalable nine-slice background using a sprite sheet. More...

#include <spk_nine_slice_background.hpp>

Collaboration diagram for spk::NineSliceBackground:

Public Member Functions
	NineSliceBackground ()
	Builds an empty nine-slice background.
void	setTexture (const spk::SpriteSheet *p_spriteSheet)
	Sets the sprite sheet texture used for the background.
const spk::SpriteSheet *	texture () const
	Returns the current sprite sheet texture.
void	setCornerSize (const spk::Vector2UInt &p_cornerSize)
	Sets the corner size for slicing.
const spk::Vector2UInt &	cornerSize () const
	Returns the current corner size.
void	setGeometry (const spk::Extend2D &p_geometry)
	Sets the geometry used to render the background.
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 nine-slice background.

Detailed Description

Renders a scalable nine-slice background using a sprite sheet.

See also

SpriteSheet

spk::NineSliceBackground background;
background.setTexture(&sheet);
background.setGeometry({{0, 0}, {100, 50}});
background.render();

Member Function Documentation

cornerSize()

const spk::Vector2UInt & spk::NineSliceBackground::cornerSize

(

)

const

Returns the current corner size.

Returns

Corner size in pixels.

geometry()

const spk::Extend2D & spk::NineSliceBackground::geometry

(

)

const

Returns the current render geometry.

Returns

Render geometry.

layer()

const float & spk::NineSliceBackground::layer

(

)

const

Returns the current layer value.

Returns

Layer value.

setCornerSize()

void spk::NineSliceBackground::setCornerSize

(

const spk::Vector2UInt &

p_cornerSize

)

Sets the corner size for slicing.

Parameters

p_cornerSize

Corner size in pixels.

setGeometry()

void spk::NineSliceBackground::setGeometry

(

const spk::Extend2D &

p_geometry

)

Sets the geometry used to render the background.

Parameters

p_geometry

Render geometry.

setLayer()

void spk::NineSliceBackground::setLayer

(

const float &

p_layer

)

Sets the rendering layer.

Parameters

p_layer

Layer value.

setTexture()

void spk::NineSliceBackground::setTexture

(

const spk::SpriteSheet *

p_spriteSheet

)

Sets the sprite sheet texture used for the background.

Parameters

p_spriteSheet

Sprite sheet to sample.

texture()

const spk::SpriteSheet * spk::NineSliceBackground::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_nine_slice_background.hpp
• srcs/structure/widget/components/spk_nine_slice_background.cpp