StencilMode¶

Enums

enum sfStencilComparison¶

Enumeration of the stencil test comparisons that can be performed.

The comparisons are mapped directly to their OpenGL equivalents, specified by glStencilFunc().

Values:

enumerator sfStencilComparisonLess¶: The stencil test passes if the new value is less than the value in the stencil buffer.

enumerator sfStencilComparisonLessEqual¶: The stencil test passes if the new value is less than or equal to the value in the stencil buffer.

enumerator sfStencilComparisonGreater¶: The stencil test passes if the new value is greater than the value in the stencil buffer.

enumerator sfStencilComparisonGreaterEqual¶: The stencil test passes if the new value is greater than or equal to the value in the stencil buffer.

enumerator sfStencilComparisonEqual¶: The stencil test passes if the new value is strictly equal to the value in the stencil buffer.

enumerator sfStencilComparisonNotEqual¶: The stencil test passes if the new value is strictly unequal to the value in the stencil buffer.

enum sfStencilUpdateOperation¶

Enumeration of the stencil buffer update operations.

The update operations are mapped directly to their OpenGL equivalents, specified by glStencilOp().

Values:

enumerator sfStencilUpdateOperationKeep¶: If the stencil test passes, the value in the stencil buffer is not modified.

enumerator sfStencilUpdateOperationZero¶: If the stencil test passes, the value in the stencil buffer is set to zero.

enumerator sfStencilUpdateOperationReplace¶: If the stencil test passes, the value in the stencil buffer is set to the new value.

enumerator sfStencilUpdateOperationIncrement¶: If the stencil test passes, the value in the stencil buffer is incremented and if required clamped.

enumerator sfStencilUpdateOperationDecrement¶: If the stencil test passes, the value in the stencil buffer is decremented and if required clamped.

enumerator sfStencilUpdateOperationInvert¶: If the stencil test passes, the value in the stencil buffer is bitwise inverted.

Variables

const sfStencilMode sfStencilMode_default¶: Define the default values for a StencilMode.

struct sfStencilValue¶

#include <StencilMode.h>

Stencil value type (also used as a mask)

Public Members

struct sfStencilMode¶

#include <StencilMode.h>

Stencil modes for drawing.

Public Members

sfStencilComparison stencilComparison¶: The comparison we’re performing the stencil test with.

sfStencilUpdateOperation stencilUpdateOperation¶: The update operation to perform if the stencil test passes.

sfStencilValue stencilReference¶: The reference value we’re performing the stencil test with.

sfStencilValue stencilMask¶: The mask to apply to both the reference value and the value in the stencil buffer.

bool stencilOnly¶: Whether we should update the color buffer in addition to the stencil buffer.