cil::Pass Class Reference

The Pass class represents a rendering pass within a graphics pipeline. More...

#include <pass.h>

Inheritance diagram for cil::Pass:

Public Types
enum class	UpdateMode {   None = 0 , Asset = 1 , Batch = 2 , Trans = 4 ,   All = Asset | Batch | Trans }

Public Member Functions
	Pass ()
void	update (UpdateMode mode=UpdateMode::All)
void	updateAsset ()
void	updateBatch ()
void	updateTrans ()
Public Member Functions inherited from cil::Object
	Object ()
virtual	~Object ()

Public Attributes
std::string	name
	This memeber stores the name of the pass.
bool	enabled
	This member indicates whether the pass is currently enabled. Disabled passes are skipped during rendering.
std::shared_ptr< Background >	background
	This member holds a shared pointer to a Background object which defines the scene background.
std::shared_ptr< Camera >	camera
	This member holds a shared pointer to a Camera object which the current pass uses for rendering.
std::shared_ptr< Node >	node
	This member holds a shared pointer to a Node object which represents the rendering objects of the current pass.
std::shared_ptr< Target >	target
	This member holds a shared pointer to a Target object which stores the rendering results, such as a buffer or texture.
int	assetVersion
int	batchVersion
int	transVersion

Detailed Description

The Pass class represents a rendering pass within a graphics pipeline.

It defines a set of objects and settings to be used for a specific stage of rendering.

Member Enumeration Documentation

UpdateMode

enum class cil::Pass::UpdateMode

strong

Enumerator
None
Asset
Batch
Trans
All

Constructor & Destructor Documentation

Pass()

cil::Pass::Pass

(

)

Member Function Documentation

update()

void cil::Pass::update

(

UpdateMode

mode = UpdateMode::All

)

updateAsset()

void cil::Pass::updateAsset

(

)

updateBatch()

void cil::Pass::updateBatch

(

)

updateTrans()

void cil::Pass::updateTrans

(

)

Member Data Documentation

assetVersion

int cil::Pass::assetVersion

background

std::shared_ptr<Background> cil::Pass::background

This member holds a shared pointer to a Background object which defines the scene background.

batchVersion

int cil::Pass::batchVersion

camera

std::shared_ptr<Camera> cil::Pass::camera

This member holds a shared pointer to a Camera object which the current pass uses for rendering.

enabled

bool cil::Pass::enabled

This member indicates whether the pass is currently enabled. Disabled passes are skipped during rendering.

name

std::string cil::Pass::name

This memeber stores the name of the pass.

node

std::shared_ptr<Node> cil::Pass::node

This member holds a shared pointer to a Node object which represents the rendering objects of the current pass.

target

std::shared_ptr<Target> cil::Pass::target

This member holds a shared pointer to a Target object which stores the rendering results, such as a buffer or texture.

transVersion

int cil::Pass::transVersion