CameraBackgroundSkyBoxBrush Class Reference

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

#include <CameraBackgroundBrush.h>

Inherits CameraBackgroundBrush.

Public Member Functions
BrushType	getBrushType () const override
	Get brush type.
void	setTexture (TextureCube *texture)
	Set skybox texture.
void	drawBackground (const SceneRenderState &state) override
	Draw background.
bool	init () override
	init Skybox.
Public Member Functions inherited from CameraBackgroundBrush
void	drawBackground (Camera *camera)
	draw the background
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.
uint64_t	getObjectID () const noexcept
	Returns the process-local diagnostic identifier assigned at construction.
virtual	~Object ()
	Destructor.

Static Public Member Functions
static CameraBackgroundSkyBoxBrush *	create (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.
static CameraBackgroundSkyBoxBrush *	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.
static CameraBackgroundDepthBrush *	createDepthBrush (float depth=1.f)
	Creates a depth brush, which clears depth buffer with a given depth.
static CameraBackgroundColorBrush *	createColorBrush (const Color &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...

Detailed Description

Skybox brush clear buffer with a skybox.

Member Function Documentation

getBrushType()

BrushType getBrushType ( ) const

inlineoverridevirtual

Get brush type.

Should be BrushType::SKYBOX

Returns

brush type

Reimplemented from CameraBackgroundBrush.

create()

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

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.

setTexture()

void setTexture

(

TextureCube *

texture

)

Set skybox texture.

Parameters

texture

Skybox texture

---

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

• CameraBackgroundBrush.h