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...
virtual void	drawBackground (Camera *)
	draw the background
Public Member Functions inherited from Ref
void	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...
virtual	~Ref ()
	Destructor. More...

Static Public Member Functions
static CameraBackgroundBrush *	createNoneBrush ()
	Creates a none brush, it does nothing when clear the background. More...
static CameraBackgroundDepthBrush *	createDepthBrush (float depth=1.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. 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...

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
bool	_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

BrushType

enum BrushType

strong

Brush types.

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

Member Function Documentation

getBrushType()

virtual BrushType getBrushType ( ) const

inlinevirtual

get brush type

Returns

BrushType

Reimplemented in CameraBackgroundSkyBoxBrush, CameraBackgroundColorBrush, and CameraBackgroundDepthBrush.

createNoneBrush()

static CameraBackgroundBrush* createNoneBrush ( )

static

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

Returns

Created brush.

createDepthBrush()

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

static

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

Parameters

depth

Depth used to clear depth buffer

Returns

Created brush

createColorBrush()

static CameraBackgroundColorBrush* createColorBrush ( const Color4F &  color, float  depth  )

static

Creates a color brush.

Parameters

color	Color of brush
depth	Depth used to clear depth buffer

Returns

Created brush

createSkyboxBrush()

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_x	texture for the right side of the texture cube face.
negative_x	texture for the up side of the texture cube face.
positive_y	texture for the top side of the texture cube face
negative_y	texture for the bottom side of the texture cube face
positive_z	texture for the forward side of the texture cube face.
negative_z	texture 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:

• CCCameraBackgroundBrush.h