sgui::ClippingLayers Class Reference

Handle clipping layers to only draw things in a given box. More...

#include <ClippingLayers.h>

Public Member Functions
uint32_t	initialize ()
	Initialize clipping layers with a base view.
uint32_t	setCurrentLayer (const sf::FloatRect &mask)
	Set current clipping layer used.
uint32_t	activeLayer () const
	Get current active clipping layer index.
void	moveToLayer (const uint32_t layerId)
	To reuse a previously set clipping layer.
void	disable ()
	Go back to base layer with no clipping.
bool	isClipped (const sf::Vector2f &position) const
	To tell if a position is visible or not (clipped).
const sf::View &	at (const uint32_t layerId) const
	Return stored clipping layers.

Public Attributes
sf::View	baseView = {}
	Base view of the clipping layers.

Detailed Description

Handle clipping layers to only draw things in a given box.

Member Function Documentation

activeLayer()

uint32_t sgui::ClippingLayers::activeLayer

(

)

const

Get current active clipping layer index.

Returns

Index of the active clipping layer

at()

const sf::View & sgui::ClippingLayers::at

(

const uint32_t

layerId

)

const

Return stored clipping layers.

disable()

void sgui::ClippingLayers::disable

(

)

Go back to base layer with no clipping.

initialize()

uint32_t sgui::ClippingLayers::initialize

(

)

Initialize clipping layers with a base view.

isClipped()

bool sgui::ClippingLayers::isClipped

(

const sf::Vector2f &

position

)

const

To tell if a position is visible or not (clipped).

Returns

true if position is not visible, false if it is visible

moveToLayer()

void sgui::ClippingLayers::moveToLayer

(

const uint32_t

layerId

)

To reuse a previously set clipping layer.

setCurrentLayer()

uint32_t sgui::ClippingLayers::setCurrentLayer

(

const sf::FloatRect &

mask

)

Set current clipping layer used.

Returns

Index of the current clipping layer

Member Data Documentation

baseView

sf::View sgui::ClippingLayers::baseView = {}

Base view of the clipping layers.

---

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

• /github/workspace/src/sgui/Render/ClippingLayers.h
• /github/workspace/src/sgui/Render/ClippingLayers.cpp