Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
CameraBackgroundDepthBrush Class Reference

Depth brush clear depth buffer with given depth. More...

Inherits CameraBackgroundBrush.

Inherited by CameraBackgroundColorBrush.

Public Member Functions

virtual BrushType getBrushType () const override
 Get brush type. More...
 
local getBrushType ()
 Get brush type. More...
 
virtual void drawBackground (Camera *camera) override
 Draw background.
 
local drawBackground ( local camera)
 Draw background.
 
void setDepth (float depth)
 Set depth. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
local 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. More...
 

Static Public Member Functions

static CameraBackgroundDepthBrushcreate (float depth)
 Create a depth brush. More...
 
var create ( var depth)
 Create a depth brush. More...
 
local create ( local depth)
 Create a depth brush. More...
 
- Static Public Member Functions inherited from CameraBackgroundBrush
static CameraBackgroundBrushcreateNoneBrush ()
 Creates a none brush, it does nothing when clear the background. More...
 
local createNoneBrush ()
 Creates a none brush, it does nothing when clear the background. More...
 
static CameraBackgroundDepthBrushcreateDepthBrush (float depth=1.f)
 Creates a depth brush, which clears depth buffer with a given depth. More...
 
local createDepthBrush ( local f)
 Creates a depth brush, which clears depth buffer with a given depth. More...
 
static CameraBackgroundColorBrushcreateColorBrush (const Color4F &color, float depth)
 Creates a color brush. More...
 
local createColorBrush ( local color, local depth)
 Creates a color brush. More...
 
static
CameraBackgroundSkyBoxBrush
createSkyboxBrush (const std::string &positive_x, const std::string &negative_x, const std::string &positive_y, const std::string &negative_y, const std::string &positive_z, const std::string &negative_z)
 Creates a Skybox brush with 6 textures. More...
 
var createSkyboxBrush ( var positive_x, var negative_x, var positive_y, var negative_y, var positive_z, var negative_z)
 Creates a Skybox brush with 6 textures. More...
 
local createSkyboxBrush ( local positive_x, local negative_x, local positive_y, local negative_y, local positive_z, local negative_z)
 Creates a Skybox brush with 6 textures. More...
 

Additional Inherited Members

- Public Types inherited from CameraBackgroundBrush
enum  BrushType
 Brush types. More...
 
- 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.
 

Detailed Description

Depth brush clear depth buffer with given depth.

Member Function Documentation

static
CameraBackgroundDepthBrush*
create
( float  depth)
static

Create a depth brush.

Parameters
depthDepth used to clear the depth buffer
Returns
Created brush
var create ( var  depth)
static

Create a depth brush.

Parameters
depthDepth used to clear the depth buffer
Returns
Created brush
local create ( local  depth)
static

Create a depth brush.

Parameters
depthDepth used to clear the depth buffer
Returns
Created brush
virtual BrushType getBrushType ( ) const
inlineoverridevirtual

Get brush type.

Should be BrushType::DEPTH

Returns
brush type

Reimplemented from CameraBackgroundBrush.

Reimplemented in CameraBackgroundColorBrush.

var getBrushType ( )
inlineoverridevirtual

Get brush type.

Should be BrushType::DEPTH

Returns
brush type

Reimplemented from CameraBackgroundBrush.

Reimplemented in CameraBackgroundColorBrush.

local getBrushType ( )
inlineoverridevirtual

Get brush type.

Should be BrushType::DEPTH

Returns
brush type

Reimplemented from CameraBackgroundBrush.

Reimplemented in CameraBackgroundColorBrush.

void setDepth ( float  depth)
inline

Set depth.

Parameters
depthDepth used to clear depth buffer
var setDepth ( var  depth)
inline

Set depth.

Parameters
depthDepth used to clear depth buffer
local setDepth ( local  depth)
inline

Set depth.

Parameters
depthDepth used to clear depth buffer

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