A Uniform instance represents a uniform shader argument. More...

#include "uniform.h"

Inheritance diagram for ion::gfx::Uniform:

Collaboration diagram for ion::gfx::Uniform:

Public Types
typedef UniformValueType	HolderType

typedef UniformType	ValueType

enum	Tag { kUniform, kAttribute }
	This is only used to determine the type of a ShaderInputRegistry::Spec since Attributes and Uniforms share the space of names. More...

Public Member Functions
	Uniform ()
	The default constructor creates an invalid Uniform instance, which should never be used as is. More...

	~Uniform ()

void	MergeValuesFrom (const Uniform &replacement)
	Merges the value of this with replacement if both have the same type. More...

bool	operator== (const Uniform &other) const

bool	operator!= (const Uniform &other) const

template<>
ION_API Uniform::ValueType	GetTypeByValue ()
	Specialize for each supported type. More...

template<>
ION_API Uniform::ValueType	GetTypeByValue ()

template<>
ION_API Uniform::ValueType	GetTypeByValue ()

template<>
ION_API Uniform::ValueType	GetTypeByValue ()

template<>
ION_API Uniform::ValueType	GetTypeByValue ()

bool	IsValid () const
	Returns true if this is a valid instance created by a ShaderInputRegistry. More...

const ShaderInputRegistry &	GetRegistry () const
	Returns the ShaderInputRegistry the shader input is defined in. More...

size_t	GetIndexInRegistry () const
	Returns the index of the shader input within the registry. More...

size_t	GetRegistryId () const
	Returns the id of the owning registry. More...

size_t	GetArrayIndex () const
	Returns the array index of this input; by default this is 0. More...

ValueType	GetType () const
	Returns the type of the shader input. More...

const T &	GetValue () const
	If this instance contains a value of type T, this returns a const reference to it. More...

const T &	GetValueAt (size_t i) const
	If this instance contains an array of values of type T with a length smaller than the passed index, this returns a const reference to the element at i. More...

size_t	GetCount () const
	Returns the number of elements in the held type. More...

bool	Is () const
	If this instance contains a value of type T, this returns true, otherwise it returns false. More...

bool	IsArrayOf () const
	If this instance contains an array of values of type T, this returns true, otherwise it returns false. More...

bool	SetValue (const T &value)
	If this instance contains a value of type T, this changes it to the new value. More...

bool	SetValueAt (size_t i, const T &value)
	If this instance contains a array of values of type T with a length larger than i, this changes the element at i to the new value. More...

uint64	GetStamp () const
	Returns the stamp of the input. More...

Static Public Member Functions
static const char *	GetShaderInputTypeName ()
	Returns a string containing "uniform". More...

static const char *	GetValueTypeName (const ValueType type)
	Returns a string representing a uniform type. More...

template<typename T >
static ValueType	GetTypeByValue ()
	Returns the type for a templated value type. More...

static Tag	GetTag ()
	Returns the tag for this input type. More...

static bool	GetMerged (const Uniform &base, const Uniform &replacement, Uniform *merged)
	Merges replacement and base into merged. More...

Protected Member Functions
void	SetNewStamp ()
	Assigns a new stamp to this Input. More...

void	Init (const ShaderInputRegistry &registry, size_t registry_id, size_t index_in_registry, size_t array_index, ValueType type, const T &value)
	Initializes the ShaderInput to a valid state. More...

void	InitArray (const ShaderInputRegistry &registry, size_t registry_id, size_t index_in_registry, size_t array_index, ValueType type, const T *values, size_t count, const base::AllocatorPtr &allocator)
	Initializes the ShaderInput to a valid state. More...

const base::AllocatorPtr &	GetArrayAllocator () const
	Returns the allocator used to make array allocations. More...

Static Protected Member Functions
static uint64	GetNewStamp ()
	Returns atomically post-incremented stamp. More...

Detailed Description

A Uniform instance represents a uniform shader argument.

A Variant is used to store the actual type-specific value, and the interface is based on that. The Uniform class is designed to be lightweight enough that instances can be copied quickly, so they can be stored in vectors, used in stacks, and so on.

Definition at line 76 of file uniform.h.

Member Typedef Documentation

typedef UniformValueType ion::gfx::ShaderInput< UniformValueType , UniformType >::HolderType

inherited

Definition at line 52 of file shaderinput.h.

typedef UniformType ion::gfx::ShaderInput< UniformValueType , UniformType >::ValueType

inherited

Definition at line 53 of file shaderinput.h.

Member Enumeration Documentation

enum ion::gfx::ShaderInputBase::Tag

inherited

This is only used to determine the type of a ShaderInputRegistry::Spec since Attributes and Uniforms share the space of names.

Enumerator
kUniform
kAttribute

Definition at line 35 of file shaderinput.h.

Constructor & Destructor Documentation

ion::gfx::Uniform::Uniform ( )

inline

The default constructor creates an invalid Uniform instance, which should never be used as is.

IsValid() will return false for such an instance.

Definition at line 81 of file uniform.h.

ion::gfx::Uniform::~Uniform ( )

inline

Definition at line 82 of file uniform.h.

Member Function Documentation

const base::AllocatorPtr& ion::gfx::ShaderInput< UniformValueType , UniformType >::GetArrayAllocator ( ) const

inlineprotectedinherited

Returns the allocator used to make array allocations.

Definition at line 207 of file shaderinput.h.

size_t ion::gfx::ShaderInput< UniformValueType , UniformType >::GetArrayIndex ( ) const

inlineinherited

Returns the array index of this input; by default this is 0.

An array index is specified in the input name with square brackets, e.g., uMyArray[2] has an index of 2.

Definition at line 76 of file shaderinput.h.

size_t ion::gfx::ShaderInput< UniformValueType , UniformType >::GetCount ( ) const

inlineinherited

Returns the number of elements in the held type.

This is 0 if this holds only a scalar value.

Definition at line 99 of file shaderinput.h.

size_t ion::gfx::ShaderInput< UniformValueType , UniformType >::GetIndexInRegistry ( ) const

inlineinherited

Returns the index of the shader input within the registry.

This should not be called on an invalid instance.

Definition at line 67 of file shaderinput.h.

Referenced by MergeValuesFrom(), and operator==().

bool ion::gfx::Uniform::GetMerged	(	const Uniform &	base,
		const Uniform &	replacement,
		Uniform *	merged
	)

static

Merges replacement and base into merged.

Returns true if a merge was needed, false otherwise in which case replacement completely replaces base.

Definition at line 225 of file uniform.cc.

Referenced by MergeValuesFrom().

uint64 ion::gfx::ShaderInputBase::GetNewStamp ( )

staticprotectedinherited

Returns atomically post-incremented stamp.

Definition at line 24 of file shaderinput.cc.

Referenced by ion::gfx::ShaderInput< UniformValueType, UniformType >::SetNewStamp().

const ShaderInputRegistry& ion::gfx::ShaderInput< UniformValueType , UniformType >::GetRegistry ( ) const

inlineinherited

Returns the ShaderInputRegistry the shader input is defined in.

This will crash if called on an invalid instance.

Definition at line 63 of file shaderinput.h.

Referenced by MergeValuesFrom(), and operator==().

size_t ion::gfx::ShaderInput< UniformValueType , UniformType >::GetRegistryId ( ) const

inlineinherited

Returns the id of the owning registry.

This value will not be useful if called on an invalid instance.

Definition at line 71 of file shaderinput.h.

const char * ion::gfx::Uniform::GetShaderInputTypeName ( )

static

Returns a string containing "uniform".

Definition at line 74 of file uniform.cc.

uint64 ion::gfx::ShaderInput< UniformValueType , UniformType >::GetStamp ( ) const

inlineinherited

Returns the stamp of the input.

The stamp is a global counter which is advanced any time a ShaderInput is modified. Two Uniforms with the same stamp are guaranteed to have the same values. Two Uniforms with different stamps may or may not have the same value.

Definition at line 145 of file shaderinput.h.

static Tag ion::gfx::Uniform::GetTag ( )

inlinestatic

Returns the tag for this input type.

Definition at line 95 of file uniform.h.

ValueType ion::gfx::ShaderInput< UniformValueType , UniformType >::GetType ( ) const

inlineinherited

Returns the type of the shader input.

This should not be called on an invalid instance.

Definition at line 80 of file shaderinput.h.

Referenced by MergeValuesFrom(), and operator==().

template<typename T >

Uniform::ValueType ion::gfx::Uniform::GetTypeByValue ( )

static

Returns the type for a templated value type.

This is instantiated for all supported types

Definition at line 101 of file uniform.cc.

References CHECK, and ion::gfx::kIntUniform.

template<>