PixelLightAPI  .
Public Types | Public Member Functions | Public Attributes
PLRenderer::StencilOp Class Reference

Stencil operations. More...

#include <Types.h>

List of all members.

Public Types

enum  Enum {
  Keep = 0, Zero = 1, Replace = 2, Incr = 3,
  Decr = 4, IncrWrap = 5, DecrWrap = 6, Invert = 7,
  Number = 8, Unknown = 9
}

Public Member Functions

 pl_enum (Enum) pl_enum_value(Keep
Keeps the current value pl_enum_value (Zero,"Sets the stencil buffer value to zero") pl_enum_value(Replace
Keeps the current value Sets
the stencil buffer value to as
specified by
RenderState::StencilRef 
pl_enum_value (Incr,"Increments the current stencil buffer value. Clamps to the maximum representable unsigned value.") pl_enum_value(Decr
Keeps the current value Sets
the stencil buffer value to as
specified by
RenderState::StencilRef
Decrements the current stencil
buffer value Clamps to zero 
pl_enum_value (IncrWrap,"Increments the current stencil buffer value. Wraps the result. (See Capabilities::bStencilWrap)") pl_enum_value(DecrWrap
Keeps the current value Sets
the stencil buffer value to as
specified by
RenderState::StencilRef
Decrements the current stencil
buffer value Clamps to zero
Decrements the current stencil
buffer value Wraps the 
result (See Capabilities::bStencilWrap)") pl_enum_value(Invert

Public Attributes

Keeps the current value Sets
the stencil buffer value to 
ref

Detailed Description

Stencil operations.


Member Enumeration Documentation

Enumerator:
Keep 

Keeps the current value

Zero 

Sets the stencil buffer value to zero

Replace 

Sets the stencil buffer value to ref, as specified by RenderState::StencilRef

Incr 

Increments the current stencil buffer value. Clamps to the maximum representable unsigned value.

Decr 

Decrements the current stencil buffer value. Clamps to zero.

IncrWrap 

Increments the current stencil buffer value. Wraps the result. (See Capabilities::bStencilWrap)

DecrWrap 

Decrements the current stencil buffer value. Wraps the result. (See Capabilities::bStencilWrap)

Invert 

Bitwise inverts the current stencil buffer value

Number 

Number of stencil operations

Unknown 

Unknown stencil operation


Member Function Documentation

Keeps the current value PLRenderer::StencilOp::pl_enum_value ( Zero  ,
"Sets the stencil buffer value to zero"   
)
Keeps the current value Sets the stencil buffer value to as specified by RenderState::StencilRef PLRenderer::StencilOp::pl_enum_value ( Incr  ,
"Increments the current stencil buffer value. Clamps to the maximum representable unsigned value."   
)
Keeps the current value Sets the stencil buffer value to as specified by RenderState::StencilRef Decrements the current stencil buffer value Clamps to zero PLRenderer::StencilOp::pl_enum_value ( IncrWrap  ,
"Increments the current stencil buffer value. Wraps the result. (See Capabilities::bStencilWrap)"   
)
Keeps the current value Sets the stencil buffer value to as specified by RenderState::StencilRef Decrements the current stencil buffer value Clamps to zero Decrements the current stencil buffer value Wraps the PLRenderer::StencilOp::result ( See Capabilities::bStencilWrap  )

Member Data Documentation

Keeps the current value Sets the stencil buffer value to PLRenderer::StencilOp::ref

The documentation for this class was generated from the following file:


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:39
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported