C++ class Rendering::Rendering Context::Rendering Parameters::BlendingParameters
BlendingParameters

public

Inheritance Graph

graph BT
	BlendingParameters
	click BlendingParameters "classRendering_1_1BlendingParameters"

Description

Public Types

enum	function_t {ZERO, ONE, SRC_COLOR, ONE_MINUS_SRC_COLOR, SRC_ALPHA, ONE_MINUS_SRC_ALPHA, DST_ALPHA, ONE_MINUS_DST_ALPHA, DST_COLOR, ONE_MINUS_DST_COLOR, SRC_ALPHA_SATURATE, CONSTANT_COLOR, ONE_MINUS_CONSTANT_COLOR, CONSTANT_ALPHA, ONE_MINUS_CONSTANT_ALPHA} Type of blending function.
enum	equation_t {FUNC_ADD, FUNC_SUBTRACT, FUNC_REVERSE_SUBTRACT} Type of blending equation.

Public Static Functions

std::string	functionToString( function_t function)
function_t	stringToFunction(const std::string & str)
uint32_t	functionToGL( function_t function)
function_t	glToFunction(uint32_t value)
std::string	equationToString( equation_t equation)
equation_t	stringToEquation(const std::string & str)
uint32_t	equationToGL( equation_t equation)
equation_t	glToEquation(uint32_t value)

Public Functions

	BlendingParameters() Create BlendingParameters representing the default OpenGL state.
	BlendingParameters( function_t srcFunc, function_t dstFunc) Create BlendingParameters with the given values.
bool	operator!=(const BlendingParameters & other) const
bool	operator==(const BlendingParameters & other) const
bool	isEnabled() const
void	enable()
void	disable()
function_t	getBlendFuncSrcRGB() const
function_t	getBlendFuncDstRGB() const
function_t	getBlendFuncSrcAlpha() const
function_t	getBlendFuncDstAlpha() const
void	setBlendFuncSrcRGB( function_t func)
void	setBlendFuncDstRGB( function_t func)
void	setBlendFuncSrcAlpha( function_t func)
void	setBlendFuncDstAlpha( function_t func)
void	setBlendFunc( function_t srcFunc, function_t dstFunc)
equation_t	getBlendEquationRGB() const
equation_t	getBlendEquationAlpha() const
void	setBlendEquationRGB( equation_t equationRGB)
void	setBlendEquationAlpha( equation_t equationAlpha)
void	setBlendEquation( equation_t equation)
void	setBlendColor(const Util::Color4f & c)
const Util::Color4f &	getBlendColor() const

---

Documentation

enum
Rendering::BlendingParameters::function_t

public

enum function_t

Enumerator		Description
Enumerator		Description
ZERO
ONE
SRC_COLOR
ONE_MINUS_SRC_COLOR
SRC_ALPHA
ONE_MINUS_SRC_ALPHA
DST_ALPHA
ONE_MINUS_DST_ALPHA
DST_COLOR
ONE_MINUS_DST_COLOR
SRC_ALPHA_SATURATE
CONSTANT_COLOR
ONE_MINUS_CONSTANT_COLOR
CONSTANT_ALPHA
ONE_MINUS_CONSTANT_ALPHA

Type of blending function.

See also: functionglBlendFuncSeparate

Author: Benjamin Eikel

Date: 2012-02-17

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

---

enum
Rendering::BlendingParameters::equation_t

public

enum equation_t

Enumerator		Description
Enumerator		Description
FUNC_ADD
FUNC_SUBTRACT
FUNC_REVERSE_SUBTRACT

Type of blending equation.

See also: functionglBlendEquationSeparate

Author: Benjamin Eikel

Date: 2012-02-17

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

---

function
Rendering::BlendingParameters::functionToString

public

static

std::string functionToString(	function_t	function )

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

---

function
Rendering::BlendingParameters::stringToFunction

public

static

function_t stringToFunction(	const std::string &	str )

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

---

function
Rendering::BlendingParameters::functionToGL

public

static

uint32_t functionToGL(	function_t	function )

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

---

function
Rendering::BlendingParameters::glToFunction

public

static

function_t glToFunction(	uint32_t	value )

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

---

function
Rendering::BlendingParameters::equationToString

public

static

std::string equationToString(	equation_t	equation )

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

---

function
Rendering::BlendingParameters::stringToEquation

public

static

equation_t stringToEquation(	const std::string &	str )

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

---

function
Rendering::BlendingParameters::equationToGL

public

static

uint32_t equationToGL(	equation_t	equation )

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

---

function
Rendering::BlendingParameters::glToEquation

public

static

equation_t glToEquation(	uint32_t	value )

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

---

function
Rendering::BlendingParameters::BlendingParameters

public

inline

explicit

BlendingParameters(	)

Create BlendingParameters representing the default OpenGL state.

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

---

function
Rendering::BlendingParameters::BlendingParameters

public

inline

explicit

BlendingParameters(	function_t	srcFunc,
	function_t	dstFunc
)

Create BlendingParameters with the given values.

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

---

function
Rendering::BlendingParameters::operator!=

public

const

inline

bool operator!=(	const BlendingParameters &	other ) const

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

---

function
Rendering::BlendingParameters::operator==

public

const

inline

bool operator==(	const BlendingParameters &	other ) const

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

---

function
Rendering::BlendingParameters::isEnabled

public

const

inline

bool isEnabled(	) const

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

---

function
Rendering::BlendingParameters::enable

public

inline

void enable(	)

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

---

function
Rendering::BlendingParameters::disable

public

inline

void disable(	)

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

---

function
Rendering::BlendingParameters::getBlendFuncSrcRGB

public

const

inline

function_t getBlendFuncSrcRGB(	) const

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

---

function
Rendering::BlendingParameters::getBlendFuncDstRGB

public

const

inline

function_t getBlendFuncDstRGB(	) const

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

---

function
Rendering::BlendingParameters::getBlendFuncSrcAlpha

public

const

inline

function_t getBlendFuncSrcAlpha(	) const

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

---

function
Rendering::BlendingParameters::getBlendFuncDstAlpha

public

const

inline

function_t getBlendFuncDstAlpha(	) const

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

---

function
Rendering::BlendingParameters::setBlendFuncSrcRGB

public

inline

void setBlendFuncSrcRGB(	function_t	func )

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

---

function
Rendering::BlendingParameters::setBlendFuncDstRGB

public

inline

void setBlendFuncDstRGB(	function_t	func )

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

---

function
Rendering::BlendingParameters::setBlendFuncSrcAlpha

public

inline

void setBlendFuncSrcAlpha(	function_t	func )

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

---

function
Rendering::BlendingParameters::setBlendFuncDstAlpha

public

inline

void setBlendFuncDstAlpha(	function_t	func )

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

---

function
Rendering::BlendingParameters::setBlendFunc

public

inline

void setBlendFunc(	function_t	srcFunc,
	function_t	dstFunc
)

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

---

function
Rendering::BlendingParameters::getBlendEquationRGB

public

const

inline

equation_t getBlendEquationRGB(	) const

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

---

function
Rendering::BlendingParameters::getBlendEquationAlpha

public

const

inline

equation_t getBlendEquationAlpha(	) const

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

---

function
Rendering::BlendingParameters::setBlendEquationRGB

public

inline

void setBlendEquationRGB(	equation_t	equationRGB )

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

---

function
Rendering::BlendingParameters::setBlendEquationAlpha

public

inline

void setBlendEquationAlpha(	equation_t	equationAlpha )

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

---

function
Rendering::BlendingParameters::setBlendEquation

public

inline

void setBlendEquation(	equation_t	equation )

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

---

function
Rendering::BlendingParameters::setBlendColor

public

inline

void setBlendColor(	const Util::Color4f &	c )

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

---

function
Rendering::BlendingParameters::getBlendColor

public

const

inline

const Util::Color4f & getBlendColor(	) const

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

---