Shader Class Reference

Defines complete rendering flow for the object. More...

#include <Shader.hpp>

Inheritance diagram for Shader:

Collaboration diagram for Shader:

Public Member Functions
BRK_API	Shader ()=default
BRK_API	~Shader () override=default
BRK_API void	SetName (StringName name)
BRK_API void	SetArchetype (StringName archetype)
BRK_API void	SetLoadPath (String loadPath)
BRK_API void	SetDescription (String description)
BRK_API void	SetVariation (ShaderVariation variation)
BRK_API void	SetFormat (MeshFormat format)
BRK_API void	SetOptions (Ref< ShaderCompileOptions > options)
BRK_API void	SetTechniques (std::vector< Ref< ShaderTechnique >> techniques)
BRK_API void	SetAllOptions (std::vector< ShaderOption > options)
BRK_API void	SetParams (Ref< ShaderParams > params)
BRK_API Ref< const ShaderTechnique >	GetTechnique (const StringName &name) const
BRK_API Ref< const ShaderTechnique >	GetTechnique (uint32 id) const
BRK_API Ref< const ShaderTechnique >	FindFirstTechnique (const ShaderTechniqueTags &tags, bool mustBeCompiled=true) const
BRK_API size_t	GetTechniquesCount () const
BRK_API const StringName &	GetName () const
BRK_API const StringName &	GetArchetype () const
BRK_API const String &	GetLoadPath () const
BRK_API const String &	GetDescription () const
BRK_API const ShaderVariation &	GetVariation () const
BRK_API const MeshFormat &	GetFormat () const
BRK_API const std::vector< Ref< ShaderTechnique > > &	GetTechniques () const
BRK_API const std::vector< ShaderOption > &	GetAllOptions () const
BRK_API const Ref< ShaderParams > &	GetParams () const
BRK_API const Ref< ShaderCompileOptions > &	GetOptions () const
Public Member Functions inherited from RefCnt
virtual	~RefCnt ()
bool	IsUnique () const
std::int32_t	GetRefs () const
std::int32_t	AddRef () const
std::int32_t	RelRef () const

Additional Inherited Members
Protected Member Functions inherited from RefCnt
virtual void	Destroy () const

Detailed Description

Defines complete rendering flow for the object.

Constructor & Destructor Documentation

Shader()

BRK_API Shader::Shader ( )

default

~Shader()

BRK_API Shader::~Shader ( )

overridedefault

Member Function Documentation

FindFirstTechnique()

Ref< const ShaderTechnique > Shader::FindFirstTechnique	(	const ShaderTechniqueTags &	tags,
		bool	mustBeCompiled = true
	)		const

GetAllOptions()

BRK_API const std::vector<ShaderOption>& Shader::GetAllOptions ( ) const

inline

GetArchetype()

BRK_API const StringName& Shader::GetArchetype ( ) const

inline

GetDescription()

BRK_API const String& Shader::GetDescription ( ) const

inline

GetFormat()

BRK_API const MeshFormat& Shader::GetFormat ( ) const

inline

GetLoadPath()

BRK_API const String& Shader::GetLoadPath ( ) const

inline

GetName()

BRK_API const StringName& Shader::GetName ( ) const

inline

GetOptions()

BRK_API const Ref<ShaderCompileOptions>& Shader::GetOptions ( ) const

inline

GetParams()

BRK_API const Ref<ShaderParams>& Shader::GetParams ( ) const

inline

GetTechnique() [1/2]

Ref< const ShaderTechnique > Shader::GetTechnique

(

const StringName &

name

)

const

GetTechnique() [2/2]

Ref< const ShaderTechnique > Shader::GetTechnique

(

uint32

id

)

const

GetTechniques()

BRK_API const std::vector<Ref<ShaderTechnique> >& Shader::GetTechniques ( ) const

inline

GetTechniquesCount()

BRK_API size_t Shader::GetTechniquesCount ( ) const

inline

GetVariation()

BRK_API const ShaderVariation& Shader::GetVariation ( ) const

inline

SetAllOptions()

void Shader::SetAllOptions

(

std::vector< ShaderOption >

options

)

SetArchetype()

void Shader::SetArchetype

(

StringName

archetype

)

SetDescription()

void Shader::SetDescription

(

String

description

)

SetFormat()

void Shader::SetFormat

(

MeshFormat

format

)

SetLoadPath()

void Shader::SetLoadPath

(

String

loadPath

)

SetName()

BRK_NS_BEGIN void Shader::SetName

(

StringName

name

)

SetOptions()

void Shader::SetOptions

(

Ref< ShaderCompileOptions >

options

)

SetParams()

void Shader::SetParams

(

Ref< ShaderParams >

params

)

SetTechniques()

void Shader::SetTechniques

(

std::vector< Ref< ShaderTechnique >>

techniques

)

SetVariation()

void Shader::SetVariation

(

ShaderVariation

variation

)

---

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

• code/runtime/render/shader/Shader.hpp
• code/runtime/render/shader/Shader.cpp