C++ class Rendering::Rendering Context::Rendering Parameters::StencilParameters
StencilParameters

public

Inheritance Graph

graph BT
	StencilParameters
	click StencilParameters "classRendering_1_1StencilParameters"

Description

Access to and modifcation of the stencil buffer.

Abstraction layer class for the stencil buffer. The OpenGL functions working with the stencil buffer are encapsulated inside.

Author: Benjamin Eikel

Date: 2012-01-11

Public Types

enum	action_t {KEEP, ZERO, REPLACE, INCR, INCR_WRAP, DECR, DECR_WRAP, INVERT}

Public Functions

	StencilParameters() Create StencilParameters representing the default OpenGL state.
bool	equalFunctionParameters(const StencilParameters & other) const Returntrueif the function subset of parameters isequalto theotherset.
bool	differentFunctionParameters(const StencilParameters & other) const Returntrueif the function subset of parameters isequalto theotherset.
bool	equalActionParameters(const StencilParameters & other) const Returntrueif the action subset of parameters isequalto theotherset.
bool	differentActionParameters(const StencilParameters & other) const Returntrueif the action subset of parameters isequalto theotherset.
bool	operator==(const StencilParameters & other) const Returntrueif the whole set of parameters isequalto theotherset.
bool	operator!=(const StencilParameters & other) const Returntrueif the whole set of parameters isunequalto theotherset.
bool	isEnabled() const
void	enable()
void	disable()
Comparison::function_t	getFunction() const
void	setFunction( Comparison::function_t newFunction)
int32_t	getReferenceValue() const
void	setReferenceValue(int32_t newValue)
const std::bitset< 32 > &	getBitMask() const
void	setBitMask(const std::bitset< 32 > & newMask)
action_t	getFailAction() const
void	setFailAction( action_t newAction)
action_t	getDepthTestFailAction() const
void	setDepthTestFailAction( action_t newAction)
action_t	getDepthTestPassAction() const
void	setDepthTestPassAction( action_t newAction)

---

Documentation

enum
Rendering::StencilParameters::action_t

public

enum action_t

Enumerator		Description
Enumerator		Description
KEEP
ZERO
REPLACE
INCR
INCR_WRAP
DECR
DECR_WRAP
INVERT

_{Defined in Rendering/RenderingContext/RenderingParameters.h:930}

---

function
Rendering::StencilParameters::StencilParameters

public

inline

explicit

StencilParameters(	)

Create StencilParameters representing the default OpenGL state.

_{Defined in Rendering/RenderingContext/RenderingParameters.h:960}

---

function
Rendering::StencilParameters::equalFunctionParameters

public

const

inline

bool equalFunctionParameters(	const StencilParameters &	other ) const

Returntrueif the function subset of parameters isequalto theotherset.

_{Defined in Rendering/RenderingContext/RenderingParameters.h:973}

---

function
Rendering::StencilParameters::differentFunctionParameters

public

const

inline

bool differentFunctionParameters(	const StencilParameters &	other ) const

Returntrueif the function subset of parameters isequalto theotherset.

_{Defined in Rendering/RenderingContext/RenderingParameters.h:977}

---

function
Rendering::StencilParameters::equalActionParameters

public

const

inline

bool equalActionParameters(	const StencilParameters &	other ) const

Returntrueif the action subset of parameters isequalto theotherset.

_{Defined in Rendering/RenderingContext/RenderingParameters.h:982}

---

function
Rendering::StencilParameters::differentActionParameters

public

const

inline

bool differentActionParameters(	const StencilParameters &	other ) const

Returntrueif the action subset of parameters isequalto theotherset.

_{Defined in Rendering/RenderingContext/RenderingParameters.h:986}

---

function
Rendering::StencilParameters::operator==

public

const

inline

bool operator==(	const StencilParameters &	other ) const

Returntrueif the whole set of parameters isequalto theotherset.

_{Defined in Rendering/RenderingContext/RenderingParameters.h:991}

---

function
Rendering::StencilParameters::operator!=

public

const

inline

bool operator!=(	const StencilParameters &	other ) const

Returntrueif the whole set of parameters isunequalto theotherset.

_{Defined in Rendering/RenderingContext/RenderingParameters.h:995}

---

function
Rendering::StencilParameters::isEnabled

public

const

inline

bool isEnabled(	) const

_{Defined in Rendering/RenderingContext/RenderingParameters.h:999}

---

function
Rendering::StencilParameters::enable

public

inline

void enable(	)

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1002}

---

function
Rendering::StencilParameters::disable

public

inline

void disable(	)

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1005}

---

function
Rendering::StencilParameters::getFunction

public

const

inline

Comparison::function_t getFunction(	) const

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1009}

---

function
Rendering::StencilParameters::setFunction

public

inline

void setFunction(	Comparison::function_t	newFunction )

See also: Parameter func of glStencilFunc

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1013}

---

function
Rendering::StencilParameters::getReferenceValue

public

const

inline

int32_t getReferenceValue(	) const

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1017}

---

function
Rendering::StencilParameters::setReferenceValue

public

inline

void setReferenceValue(	int32_t	newValue )

See also: Parameter ref of glStencilFunc

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1021}

---

function
Rendering::StencilParameters::getBitMask

public

const

inline

const std::bitset< 32 > & getBitMask(	) const

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1025}

---

function
Rendering::StencilParameters::setBitMask

public

inline

void setBitMask(	const std::bitset< 32 > &	newMask )

See also: Parameter mask of glStencilFunc

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1029}

---

function
Rendering::StencilParameters::getFailAction

public

const

inline

action_t getFailAction(	) const

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1033}

---

function
Rendering::StencilParameters::setFailAction

public

inline

void setFailAction(	action_t	newAction )

See also: Parameter sfail of glStencilOp

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1037}

---

function
Rendering::StencilParameters::getDepthTestFailAction

public

const

inline

action_t getDepthTestFailAction(	) const

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1041}

---

function
Rendering::StencilParameters::setDepthTestFailAction

public

inline

void setDepthTestFailAction(	action_t	newAction )

See also: Parameter dpfail of glStencilOp

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1045}

---

function
Rendering::StencilParameters::getDepthTestPassAction

public

const

inline

action_t getDepthTestPassAction(	) const

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1049}

---

function
Rendering::StencilParameters::setDepthTestPassAction

public

inline

void setDepthTestPassAction(	action_t	newAction )

See also: Parameter dppass of glStencilOp

_{Defined in Rendering/RenderingContext/RenderingParameters.h:1053}

---