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

Defines a brush to clear the background of camera. More...

Inherits Ref.

Inherited by CameraBackgroundDepthBrush, and CameraBackgroundSkyBoxBrush.

Public Types

enum  BrushType
 Brush types. More...
 

Public Member Functions

virtual BrushType getBrushType () const
 get brush type More...
 
var getBrushType ()
 get brush type More...
 
local getBrushType ()
 get brush type More...
 
virtual void drawBackground (Camera *)
 draw the background
 
var drawBackground ()
 draw the background
 
local drawBackground ()
 draw the background
 
- 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 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 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

Defines a brush to clear the background of camera.

There are 4 types of brush. None brush do nothing, Depth brush clear background with given depth, Color brush clear background with given color and depth, Skybox brush clear the background with a skybox. Camera uses depth brush by default.

Member Enumeration Documentation

enum BrushType
strong

Brush types.

There are 4 types of brush. See CameraBackgroundDepthBrush, CameraBackgroundColorBrush, CameraBackgroundSkyBoxBrush for more information.

Member Function Documentation

virtual BrushType getBrushType ( ) const
inlinevirtual

get brush type

Returns
BrushType

Reimplemented in CameraBackgroundSkyBoxBrush, CameraBackgroundColorBrush, and CameraBackgroundDepthBrush.

var getBrushType ( )
inlinevirtual

get brush type

Returns
BrushType

Reimplemented in CameraBackgroundSkyBoxBrush, CameraBackgroundColorBrush, and CameraBackgroundDepthBrush.

local getBrushType ( )
inlinevirtual

get brush type

Returns
BrushType

Reimplemented in CameraBackgroundSkyBoxBrush, CameraBackgroundColorBrush, and CameraBackgroundDepthBrush.

static CameraBackgroundBrush*
createNoneBrush
( )
static

Creates a none brush, it does nothing when clear the background.

Returns
Created brush.
var createNoneBrush ( )
static

Creates a none brush, it does nothing when clear the background.

Returns
Created brush.
local createNoneBrush ( )
static

Creates a none brush, it does nothing when clear the background.

Returns
Created brush.
static
CameraBackgroundDepthBrush*
createDepthBrush
( float  depth = 1.f)
static

Creates a depth brush, which clears depth buffer with a given depth.

Parameters
depthDepth used to clear depth buffer
Returns
Created brush
var createDepthBrush ( var  depth = 1.f)
static

Creates a depth brush, which clears depth buffer with a given depth.

Parameters
depthDepth used to clear depth buffer
Returns
Created brush
local createDepthBrush ( local  depth = 1.f)
static

Creates a depth brush, which clears depth buffer with a given depth.

Parameters
depthDepth used to clear depth buffer
Returns
Created brush
static
CameraBackgroundColorBrush*
createColorBrush
( const Color4F color,
float  depth 
)
static

Creates a color brush.

Parameters
colorColor of brush
depthDepth used to clear depth buffer
Returns
Created brush
var createColorBrush ( var  color,
var  depth 
)
static

Creates a color brush.

Parameters
colorColor of brush
depthDepth used to clear depth buffer
Returns
Created brush
local createColorBrush ( local  color,
local  depth 
)
static

Creates a color brush.

Parameters
colorColor of brush
depthDepth used to clear depth buffer
Returns
Created brush
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 
)
static

Creates a Skybox brush with 6 textures.

Parameters
positive_xtexture for the right side of the texture cube face.
negative_xtexture for the up side of the texture cube face.
positive_ytexture for the top side of the texture cube face
negative_ytexture for the bottom side of the texture cube face
positive_ztexture for the forward side of the texture cube face.
negative_ztexture for the rear side of the texture cube face.
Returns
A new brush inited with given parameters.
var createSkyboxBrush ( var  positive_x,
var  negative_x,
var  positive_y,
var  negative_y,
var  positive_z,
var  negative_z 
)
static

Creates a Skybox brush with 6 textures.

Parameters
positive_xtexture for the right side of the texture cube face.
negative_xtexture for the up side of the texture cube face.
positive_ytexture for the top side of the texture cube face
negative_ytexture for the bottom side of the texture cube face
positive_ztexture for the forward side of the texture cube face.
negative_ztexture for the rear side of the texture cube face.
Returns
A new brush inited with given parameters.
local createSkyboxBrush ( local  positive_x,
local  negative_x,
local  positive_y,
local  negative_y,
local  positive_z,
local  negative_z 
)
static

Creates a Skybox brush with 6 textures.

Parameters
positive_xtexture for the right side of the texture cube face.
negative_xtexture for the up side of the texture cube face.
positive_ytexture for the top side of the texture cube face
negative_ytexture for the bottom side of the texture cube face
positive_ztexture for the forward side of the texture cube face.
negative_ztexture for the rear side of the texture cube face.
Returns
A new brush inited with given parameters.

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