Cocos2d-x  v3.11
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
CameraBackgroundSkyBoxBrush Class Reference

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

Inherits CameraBackgroundBrush.

Public Member Functions

virtual BrushType getBrushType () const override
 Get brush type. More...
 
void setTexture (TextureCube *texture)
 Set skybox texture Skybox texture.
 
virtual void drawBackground (Camera *camera) override
 Draw background.
 
bool isActived () const
 Get if the sky box background brush is actived. More...
 
void setActived (bool actived)
 Set sky box background brush is actived status. More...
 
virtual void setTextureValid (bool valid)
 Set sky box background texture validate status.
 
virtual bool isValid () override
 Get if the sky box background brush is valid. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void 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...
 
virtual ~Ref ()
 Destructor.
 

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...
 
static
CameraBackgroundSkyBoxBrush
create ()
 Creates a Skybox brush.
 
- Static Public Member Functions inherited from CameraBackgroundBrush
static CameraBackgroundBrushcreateNoneBrush ()
 Creates a none brush, it does nothing when clear the background Created brush.
 
static CameraBackgroundDepthBrushcreateDepthBrush (float depth=1.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 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...
 

Protected Member Functions

virtual bool init () override
 init Skybox.
 

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
 
int _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
bool _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...
 

Detailed Description

Skybox brush clear buffer with a skybox.

Member Function Documentation

virtual BrushType getBrushType ( ) const
inlineoverridevirtual

Get brush type.

Should be BrushType::SKYBOX 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_xtexture for the right side of the texture cube face. texture for the up side of the texture cube face. texture for the top side of the texture cube face texture for the bottom side of the texture cube face texture for the forward side of the texture cube face. texture for the rear side of the texture cube face. A new brush inited with given parameters.
bool isActived ( ) const

Get if the sky box background brush is actived.

If the background brush is actived.

void setActived ( bool  actived)

Set sky box background brush is actived status.

Background brush active status to be set.

virtual bool isValid ( )
overridevirtual

Get if the sky box background brush is valid.

If the background brush is valid.

Reimplemented from CameraBackgroundBrush.


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