ClanLib
2.3.7
|
Container class for states related to reading, writing and tests performed on buffers. More...
#include <buffer_control.h>
Public Member Functions | |
Construction | |
CL_BufferControl () | |
Constructs a buffer control description object. More... | |
virtual | ~CL_BufferControl () |
Attributes | |
bool | is_stencil_test_enabled () const |
Returns true if stencil test is enabled. More... | |
CL_CompareFunction | get_stencil_compare_func_front () const |
Returns the stencil compare function for front facing polygons, points, lines and bitmaps. More... | |
CL_CompareFunction | get_stencil_compare_func_back () const |
Returns the stencil compare function for back facing polygons. More... | |
int | get_stencil_compare_reference_front () const |
Returns the stencil compare reference for front facing polygons, points, lines and bitmaps. More... | |
int | get_stencil_compare_reference_back () const |
Returns the stencil compare reference for back facing polygons. More... | |
CL_StencilOp | get_stencil_fail_front () const |
Returns the stencil operation to perform when test fails for front facing polygons, points, lines and bitmaps. More... | |
CL_StencilOp | get_stencil_fail_back () const |
Returns the stencil operation to perform when test fails for back facing polygons. More... | |
CL_StencilOp | get_stencil_pass_depth_pass_front () const |
Returns the stencil operation to perform when test passes for front facing polygons, points, lines and bitmaps. More... | |
CL_StencilOp | get_stencil_pass_depth_pass_back () const |
Returns the stencil operation to perform when test passes for back facing polygons. More... | |
CL_StencilOp | get_stencil_pass_depth_fail_front () const |
Returns the stencil operation to perform when depth test passes but stencil test fails for front facing polygons, points, lines and bitmaps. More... | |
CL_StencilOp | get_stencil_pass_depth_fail_back () const |
Returns the stencil operation to perform when depth test passes but stencil test fails for back facing polygons. More... | |
unsigned char | get_stencil_compare_mask_front () const |
Returns the stencil comparation mask for front facing polygons, points, lines and bitmaps. More... | |
unsigned char | get_stencil_compare_mask_back () const |
Returns the stencil comparation mask for back facing polygons. More... | |
unsigned char | get_stencil_write_mask_front () const |
Returns the stencil write mask for front facing polygons, points, lines and bitmaps. More... | |
unsigned char | get_stencil_write_mask_back () const |
Returns the stencil write mask for back facing polygons. More... | |
bool | is_depth_test_enabled () const |
Returns true if the depth test is enabled. More... | |
bool | is_depth_write_enabled () const |
Returns true if depth writing is enabled. More... | |
CL_CompareFunction | get_depth_compare_function () const |
Returns the depth test function. More... | |
void | is_color_write_enabled (bool &red, bool &green, bool &blue, bool &alpha) const |
Retrieves which color components are write enabled. More... | |
CL_DrawBuffer | get_draw_buffer () const |
Returns the used draw buffer. More... | |
bool | is_logic_op_enabled () const |
Returns true if logic operations are enabled. More... | |
CL_LogicOp | get_logic_op () const |
Returns the set logic operations. More... | |
Operations | |
void | enable_stencil_test (bool enabled) |
Enables/disables stencil testing. More... | |
void | set_stencil_compare_func (CL_CompareFunction front, CL_CompareFunction back) |
Set stencil compare function. More... | |
void | set_stencil_compare_reference (int front_ref, int back_ref) |
Set stencil compare reference values. More... | |
void | set_stencil_write_mask (unsigned char front_facing_mask, unsigned char back_facing_mask) |
Set stencil write masks. More... | |
void | set_stencil_fail (CL_StencilOp front, CL_StencilOp back) |
Set stencil failed test operations. More... | |
void | set_stencil_pass_depth_pass (CL_StencilOp front, CL_StencilOp back) |
Set stencil passed test operations. More... | |
void | set_stencil_pass_depth_fail (CL_StencilOp front, CL_StencilOp back) |
Set stencil passed depth test but failed stencil test operations. More... | |
void | set_stencil_compare_mask (int front_mask, int back_mask) |
Set stencil comparation masks. More... | |
void | enable_depth_test (bool enabled) |
Enables/disables depth testing. More... | |
void | enable_depth_write (bool enabled) |
Enables/disables depth writing. More... | |
void | set_depth_compare_function (CL_CompareFunction func) |
Set depth test function. More... | |
void | enable_color_write (bool enabled) |
Enable/disable writing to the color buffer. More... | |
void | enable_color_write (bool red, bool green, bool blue, bool alpha) |
Enable color write. More... | |
void | set_draw_buffer (CL_DrawBuffer buffer) |
Set used draw buffer. More... | |
void | enable_logic_op (bool enabled) |
Enable/disable logic op. More... | |
void | set_logic_op (CL_LogicOp op) |
Set logic operation. More... | |
Container class for states related to reading, writing and tests performed on buffers.
CL_BufferControl::CL_BufferControl | ( | ) |
Constructs a buffer control description object.
|
virtual |
void CL_BufferControl::enable_color_write | ( | bool | enabled) |
Enable/disable writing to the color buffer.
void CL_BufferControl::enable_color_write | ( | bool | red, |
bool | green, | ||
bool | blue, | ||
bool | alpha | ||
) |
Enable color write.
red | = bool |
green | = bool |
blue | = bool |
alpha | = bool |
void CL_BufferControl::enable_depth_test | ( | bool | enabled) |
Enables/disables depth testing.
void CL_BufferControl::enable_depth_write | ( | bool | enabled) |
Enables/disables depth writing.
void CL_BufferControl::enable_logic_op | ( | bool | enabled) |
Enable/disable logic op.
void CL_BufferControl::enable_stencil_test | ( | bool | enabled) |
Enables/disables stencil testing.
CL_CompareFunction CL_BufferControl::get_depth_compare_function | ( | ) | const |
Returns the depth test function.
CL_DrawBuffer CL_BufferControl::get_draw_buffer | ( | ) | const |
Returns the used draw buffer.
CL_LogicOp CL_BufferControl::get_logic_op | ( | ) | const |
Returns the set logic operations.
CL_CompareFunction CL_BufferControl::get_stencil_compare_func_back | ( | ) | const |
Returns the stencil compare function for back facing polygons.
CL_CompareFunction CL_BufferControl::get_stencil_compare_func_front | ( | ) | const |
Returns the stencil compare function for front facing polygons, points, lines and bitmaps.
unsigned char CL_BufferControl::get_stencil_compare_mask_back | ( | ) | const |
Returns the stencil comparation mask for back facing polygons.
unsigned char CL_BufferControl::get_stencil_compare_mask_front | ( | ) | const |
Returns the stencil comparation mask for front facing polygons, points, lines and bitmaps.
int CL_BufferControl::get_stencil_compare_reference_back | ( | ) | const |
Returns the stencil compare reference for back facing polygons.
int CL_BufferControl::get_stencil_compare_reference_front | ( | ) | const |
Returns the stencil compare reference for front facing polygons, points, lines and bitmaps.
CL_StencilOp CL_BufferControl::get_stencil_fail_back | ( | ) | const |
Returns the stencil operation to perform when test fails for back facing polygons.
CL_StencilOp CL_BufferControl::get_stencil_fail_front | ( | ) | const |
Returns the stencil operation to perform when test fails for front facing polygons, points, lines and bitmaps.
CL_StencilOp CL_BufferControl::get_stencil_pass_depth_fail_back | ( | ) | const |
Returns the stencil operation to perform when depth test passes but stencil test fails for back facing polygons.
CL_StencilOp CL_BufferControl::get_stencil_pass_depth_fail_front | ( | ) | const |
Returns the stencil operation to perform when depth test passes but stencil test fails for front facing polygons, points, lines and bitmaps.
CL_StencilOp CL_BufferControl::get_stencil_pass_depth_pass_back | ( | ) | const |
Returns the stencil operation to perform when test passes for back facing polygons.
CL_StencilOp CL_BufferControl::get_stencil_pass_depth_pass_front | ( | ) | const |
Returns the stencil operation to perform when test passes for front facing polygons, points, lines and bitmaps.
unsigned char CL_BufferControl::get_stencil_write_mask_back | ( | ) | const |
Returns the stencil write mask for back facing polygons.
unsigned char CL_BufferControl::get_stencil_write_mask_front | ( | ) | const |
Returns the stencil write mask for front facing polygons, points, lines and bitmaps.
void CL_BufferControl::is_color_write_enabled | ( | bool & | red, |
bool & | green, | ||
bool & | blue, | ||
bool & | alpha | ||
) | const |
Retrieves which color components are write enabled.
bool CL_BufferControl::is_depth_test_enabled | ( | ) | const |
Returns true if the depth test is enabled.
bool CL_BufferControl::is_depth_write_enabled | ( | ) | const |
Returns true if depth writing is enabled.
bool CL_BufferControl::is_logic_op_enabled | ( | ) | const |
Returns true if logic operations are enabled.
bool CL_BufferControl::is_stencil_test_enabled | ( | ) | const |
Returns true if stencil test is enabled.
void CL_BufferControl::set_depth_compare_function | ( | CL_CompareFunction | func) |
Set depth test function.
void CL_BufferControl::set_draw_buffer | ( | CL_DrawBuffer | buffer) |
Set used draw buffer.
void CL_BufferControl::set_logic_op | ( | CL_LogicOp | op) |
Set logic operation.
void CL_BufferControl::set_stencil_compare_func | ( | CL_CompareFunction | front, |
CL_CompareFunction | back | ||
) |
Set stencil compare function.
void CL_BufferControl::set_stencil_compare_mask | ( | int | front_mask, |
int | back_mask | ||
) |
Set stencil comparation masks.
void CL_BufferControl::set_stencil_compare_reference | ( | int | front_ref, |
int | back_ref | ||
) |
Set stencil compare reference values.
void CL_BufferControl::set_stencil_fail | ( | CL_StencilOp | front, |
CL_StencilOp | back | ||
) |
Set stencil failed test operations.
void CL_BufferControl::set_stencil_pass_depth_fail | ( | CL_StencilOp | front, |
CL_StencilOp | back | ||
) |
Set stencil passed depth test but failed stencil test operations.
void CL_BufferControl::set_stencil_pass_depth_pass | ( | CL_StencilOp | front, |
CL_StencilOp | back | ||
) |
Set stencil passed test operations.
void CL_BufferControl::set_stencil_write_mask | ( | unsigned char | front_facing_mask, |
unsigned char | back_facing_mask | ||
) |
Set stencil write masks.