Cocos2d-x  v3.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
RenderState Class Reference

Defines the rendering state of the graphics device. More...

Inherits Ref.

Inherited by Material, Pass, and Technique.

Classes

class  StateBlock
 Defines a block of fixed-function render states that can be applied to a RenderState object. More...
 

Public Types

enum  DepthFunction
 Defines the supported depth compare functions. More...
 
enum  CullFaceSide
 Defines culling criteria for front-facing, back-facing and both-side facets.
 
enum  FrontFace
 Defines the winding of vertices in faces that are considered front facing. More...
 
enum  StencilFunction
 Defines the supported stencil compare functions. More...
 
enum  StencilOperation
 Defines the supported stencil operations to perform. More...
 

Public Member Functions

std::string getName () const
 Get name Name.
 
void setTexture (Texture2D *texture)
 Texture that will use in the CC_Texture0 uniform. More...
 
Texture2DgetTexture () const
 Returns the texture that is going to be used for CC_Texture0. More...
 
void bind (Pass *pass)
 Binds the render state for this RenderState and any of its parents, top-down, for the given pass. More...
 
RenderStategetTopmost (RenderState *below)
 Returns the topmost RenderState in the hierarchy below the given RenderState. More...
 
var getTopmost ( var below)
 Returns the topmost RenderState in the hierarchy below the given RenderState. More...
 
local getTopmost ( local below)
 Returns the topmost RenderState in the hierarchy below the given RenderState. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
local retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor.
 

Static Public Member Functions

static void initialize ()
 Static initializer that is called during game startup.
 
static void finalize ()
 Static finalizer that is called during game shutdown.
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 
bool _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
local _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 

Detailed Description

Defines the rendering state of the graphics device.

Member Function Documentation

void setTexture ( Texture2D texture)

Texture that will use in the CC_Texture0 uniform.

Added to be backwards compatible. Use Samplers from .material instead. Texture to be binding.

var setTexture ( var  texture)

Texture that will use in the CC_Texture0 uniform.

Added to be backwards compatible. Use Samplers from .material instead. Texture to be binding.

local setTexture ( local  texture)

Texture that will use in the CC_Texture0 uniform.

Added to be backwards compatible. Use Samplers from .material instead. Texture to be binding.

Texture2D* getTexture ( ) const

Returns the texture that is going to be used for CC_Texture0.

Added to be backwards compatible. texture that is going to be used for CC_Texture0.

var getTexture ( )

Returns the texture that is going to be used for CC_Texture0.

Added to be backwards compatible. texture that is going to be used for CC_Texture0.

local getTexture ( )

Returns the texture that is going to be used for CC_Texture0.

Added to be backwards compatible. texture that is going to be used for CC_Texture0.

void bind ( Pass pass)

Binds the render state for this RenderState and any of its parents, top-down, for the given pass.

Not used.

var bind ( var  pass)

Binds the render state for this RenderState and any of its parents, top-down, for the given pass.

Not used.

local bind ( local  pass)

Binds the render state for this RenderState and any of its parents, top-down, for the given pass.

Not used.

RenderState* getTopmost ( RenderState below)

Returns the topmost RenderState in the hierarchy below the given RenderState.

The top most render state below the given RenderState.

var getTopmost ( var  below)

Returns the topmost RenderState in the hierarchy below the given RenderState.

The top most render state below the given RenderState.

local getTopmost ( local  below)

Returns the topmost RenderState in the hierarchy below the given RenderState.

The top most render state below the given RenderState.


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