CameraBackgroundColorBrush Class Reference

Color brush clear buffer with given depth and color. More...

Inherits CameraBackgroundDepthBrush.

Public Member Functions
virtual BrushType	getBrushType () const override
	Get brush type. More...
local	getBrushType ()
	Get brush type. More...
void	setColor (const Color4F &color)
	Set clear color Color used to clear the color buffer.
Public Member Functions inherited from CameraBackgroundDepthBrush
virtual void	drawBackground (Camera *camera) override
	Draw background.
local	drawBackground ( local camera)
	Draw background.
void	setDepth (float depth)
	Set depth Depth used to clear depth buffer.
Public Member Functions inherited from CameraBackgroundBrush
virtual bool	isValid ()
	is valid?
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...
Ref *	autorelease ()
	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 CameraBackgroundColorBrush *	create (const Color4F &color, float depth)
	Create a color brush Color used to clear the color buffer Depth used to clear the depth buffer Created brush.
var	create ( var color, var depth)
	Create a color brush Color used to clear the color buffer Depth used to clear the depth buffer Created brush.
local	create ( local color, local depth)
	Create a color brush Color used to clear the color buffer Depth used to clear the depth buffer Created brush.
Static Public Member Functions inherited from CameraBackgroundDepthBrush
static CameraBackgroundDepthBrush *	create (float depth)
	Create a depth brush Depth used to clear the depth buffer Created brush.
local	create ( local depth)
	Create a depth brush Depth used to clear the depth buffer Created brush.
Static Public Member Functions inherited from CameraBackgroundBrush
static CameraBackgroundBrush *	createNoneBrush ()
	Creates a none brush, it does nothing when clear the background Created brush.
static CameraBackgroundDepthBrush *	createDepthBrush (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 CameraBackgroundColorBrush *	createColorBrush (const Color4F &color, float depth)
	Creates a color brush Color of brush Depth used to clear depth buffer Created brush.
local	createColorBrush ( local color, local depth)
	Creates a color brush Color of brush Depth used to clear depth buffer 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)
	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 { NONE, DEPTH, COLOR, SKYBOX }
	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.
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

Color brush clear buffer with given depth and color.

Member Function Documentation

virtual BrushType getBrushType ( ) const

inlineoverridevirtual

Get brush type.

Should be BrushType::COLOR brush type

Reimplemented from CameraBackgroundDepthBrush.

var getBrushType ( )

inlineoverridevirtual

Get brush type.

Should be BrushType::COLOR brush type

Reimplemented from CameraBackgroundDepthBrush.

local getBrushType ( )

inlineoverridevirtual

Get brush type.

Should be BrushType::COLOR brush type

Reimplemented from CameraBackgroundDepthBrush.

---

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

• CCCameraBackgroundBrush.h