CameraBackgroundDepthBrush Class Reference

Depth brush clear depth buffer with given depth. More...

#include <CameraBackgroundBrush.h>

Inherits CameraBackgroundBrush.

Inherited by CameraBackgroundColorBrush.

Public Member Functions
virtual BrushType	getBrushType () const override
	Get brush type.
virtual void	drawBackground (Camera *camera) override
	Draw background.
void	setDepth (float depth)
	Set depth.
Public Member Functions inherited from Object
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Object *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Object's current reference count.
virtual	~Object ()
	Destructor.

Static Public Member Functions
static CameraBackgroundDepthBrush *	create (float depth)
	Create a depth brush.
Static Public Member Functions inherited from CameraBackgroundBrush
static CameraBackgroundBrush *	createNoneBrush ()
	Creates a none brush, it does nothing when clear the background.
static CameraBackgroundDepthBrush *	createDepthBrush (float depth=1.f)
	Creates a depth brush, which clears depth buffer with a given depth.
static CameraBackgroundColorBrush *	createColorBrush (const Color4F &color, float depth)
	Creates a color brush.
static CameraBackgroundSkyBoxBrush *	createSkyboxBrush (std::string_view positive_x, std::string_view negative_x, std::string_view positive_y, std::string_view negative_y, std::string_view positive_z, std::string_view negative_z)
	Creates a Skybox brush with 6 textures.

Additional Inherited Members
Public Types inherited from CameraBackgroundBrush
enum class	BrushType
	Brush types. More...
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.

Detailed Description

Depth brush clear depth buffer with given depth.

Member Function Documentation

create()

static CameraBackgroundDepthBrush * create ( float depth )

static

Create a depth brush.

Parameters

depth

Depth used to clear the depth buffer

Returns

Created brush

getBrushType()

virtual BrushType getBrushType ( ) const

inlineoverridevirtual

Get brush type.

Should be BrushType::DEPTH

Returns

brush type

Reimplemented from CameraBackgroundBrush.

Reimplemented in CameraBackgroundColorBrush.

setDepth()

void setDepth ( float depth )

inline

Set depth.

Parameters

depth

Depth used to clear depth buffer

---

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

• CameraBackgroundBrush.h