Skybox brush clear buffer with a skybox. More...

Inherits CameraBackgroundBrush.

Public Member Functions
virtual BrushType	getBrushType () const override
	Get brush type. More...

local	getBrushType ()
	Get brush type. More...

void	setTexture (TextureCube *texture)
	Set skybox texture. More...

var	setTexture ( var texture)
	Set skybox texture. More...

local	setTexture ( local texture)
	Set skybox texture. More...

virtual void	drawBackground (Camera *camera) override
	Draw 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 CameraBackgroundSkyBoxBrush *	create (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...

local	create ( 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...

static CameraBackgroundSkyBoxBrush *	create ()
	Creates a Skybox brush with 6 textures.

local	create ()
	Creates a Skybox brush with 6 textures.

Static Public Member Functions inherited from CameraBackgroundBrush
static CameraBackgroundBrush *	createNoneBrush ()
	Creates a none brush, it does nothing when clear the background. More...

var	createNoneBrush ()
	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 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. 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...

Protected Member Functions
virtual bool	init () override
	init Skybox.

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

Skybox brush clear buffer with a skybox.

Member Function Documentation

virtual BrushType getBrushType ( ) const

inlineoverridevirtual

Get brush type.

Should be BrushType::SKYBOX

Returns: brush type

Reimplemented from CameraBackgroundBrush.

var getBrushType ( )

inlineoverridevirtual

Get brush type.

Should be BrushType::SKYBOX

Returns: brush type

Reimplemented from CameraBackgroundBrush.

local getBrushType ( )

inlineoverridevirtual

Get brush type.

Should be BrushType::SKYBOX

Returns: brush type

Reimplemented from CameraBackgroundBrush.

static CameraBackgroundSkyBoxBrush* create	(	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.

var create	(	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_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.

local create	(	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_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.

void setTexture ( TextureCube * texture )

Set skybox texture.

Parameters

texture Skybox texture

var setTexture ( var texture )

Set skybox texture.

Parameters

texture Skybox texture

local setTexture ( local texture )

Set skybox texture.

Parameters

texture Skybox texture

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

CCCameraBackgroundBrush.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation