cil::Background Class Reference

The Background class represents the configuration for a background element used in a rendering Pass. More...

#include <background.h>

Inheritance diagram for cil::Background:

Public Member Functions
	Background (const std::shared_ptr< Vector2i > &size, const std::shared_ptr< Color4f > &colorMask=nullptr, const std::shared_ptr< Real > &depthMask=nullptr, const std::shared_ptr< Integer > &stencilMask=nullptr, const std::shared_ptr< Vector2i > &coordinate=nullptr)
Public Member Functions inherited from cil::Object
	Object ()
virtual	~Object ()

Public Attributes
std::shared_ptr< Vector2i >	size
	This memeber is a shared pointer to a 2D integer vector specifying the size(width and height) of the background element.
std::shared_ptr< Color4f >	colorMask
	This memeber is a shared pointer to the color value with four floats(RGBA) defining the base color of the background.
std::shared_ptr< Real >	depthMask
	This memeber is a shared pointer to a Real value used for controlling the depth contributes of the background during rendering.
std::shared_ptr< Integer >	stencilMask
	This memeber is a shared pointer to a Integer value used for stencil buffer operation in the rendering pipeline, allowing for effects like masking.
std::shared_ptr< Vector2i >	coordinate
	This memeber is a shared pointer to a 2D integer vector specifying the screen-space coordinates where the background element should be positioned.

Detailed Description

The Background class represents the configuration for a background element used in a rendering Pass.

Constructor & Destructor Documentation

Background()

cil::Background::Background	(	const std::shared_ptr< Vector2i > &	size,
		const std::shared_ptr< Color4f > &	colorMask = nullptr,
		const std::shared_ptr< Real > &	depthMask = nullptr,
		const std::shared_ptr< Integer > &	stencilMask = nullptr,
		const std::shared_ptr< Vector2i > &	coordinate = nullptr )

Member Data Documentation

colorMask

std::shared_ptr<Color4f> cil::Background::colorMask

This memeber is a shared pointer to the color value with four floats(RGBA) defining the base color of the background.

coordinate

std::shared_ptr<Vector2i> cil::Background::coordinate

This memeber is a shared pointer to a 2D integer vector specifying the screen-space coordinates where the background element should be positioned.

depthMask

std::shared_ptr<Real> cil::Background::depthMask

This memeber is a shared pointer to a Real value used for controlling the depth contributes of the background during rendering.

size

std::shared_ptr<Vector2i> cil::Background::size

This memeber is a shared pointer to a 2D integer vector specifying the size(width and height) of the background element.

stencilMask

std::shared_ptr<Integer> cil::Background::stencilMask

This memeber is a shared pointer to a Integer value used for stencil buffer operation in the rendering pipeline, allowing for effects like masking.