Public Member Functions | Properties

CC3OpenGLES11StateTrackerStencilOperation Class Reference

CC3OpenGLES11StateTrackerStencilOperation is a type of CC3OpenGLES11StateTrackerComposite that tracks the stencil operations that occur when the stencil test fails, the depth test fails, and the depth test passes. More...

#import <CC3OpenGLES11State.h>

Inheritance diagram for CC3OpenGLES11StateTrackerStencilOperation:
Inheritance graph
[legend]
Collaboration diagram for CC3OpenGLES11StateTrackerStencilOperation:
Collaboration graph
[legend]

List of all members.

Public Member Functions

(void) - applyStencilFail:andDepthFail:andDepthPass:

Properties

CC3OpenGLES11StateTrackerEnumerationdepthFail
CC3OpenGLES11StateTrackerEnumerationdepthPass
CC3OpenGLES11StateTrackerEnumerationstencilFail

Detailed Description

CC3OpenGLES11StateTrackerStencilOperation is a type of CC3OpenGLES11StateTrackerComposite that tracks the stencil operations that occur when the stencil test fails, the depth test fails, and the depth test passes.

The fail, depthFail and depthPass values are read from GL individually, using distinct primitive trackers for each value. All three values are set into the GL engine together using a single call to the GL set function glStencilOp.

The originalValueHandling property is set to kCC3GLESStateOriginalValueIgnore, which will not read the GL value from the GL engine in the open method, and will not restore the value in the close method.


Member Function Documentation

- (void) applyStencilFail: (GLenum)  failOp
andDepthFail: (GLenum)  zFailOp
andDepthPass: (GLenum)  zPassOp 

Sets the stencil fail, depth fail, and depth pass values together.

The values will be set in the GL engine only if at least one of the values has actually changed.

Uses the GL set function glStencilOp to set the values in the GL engine.


Property Documentation

- (CC3OpenGLES11StateTrackerEnumeration *) depthFail [read, write, retain]

Tracks the stencil operation when the depth test fails (GL get name GL_STENCIL_PASS_DEPTH_FAIL)

- (CC3OpenGLES11StateTrackerEnumeration *) depthPass [read, write, retain]

Tracks the stencil operation when the depth test passes (GL get name GL_STENCIL_PASS_DEPTH_PASS)

- (CC3OpenGLES11StateTrackerEnumeration *) stencilFail [read, write, retain]

Tracks the stencil operation when the stencil test fails (GL get name GL_STENCIL_FAIL)


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