A ShaderProgram represents an OpenGL shader program that can be applied to shapes. More...

#include "shaderprogram.h"

Inheritance diagram for ion::gfx::ShaderProgram:

Collaboration diagram for ion::gfx::ShaderProgram:

Public Types
enum	Changes { kVertexShaderChanged = kNumBaseChanges, kFragmentShaderChanged, kNumChanges }
	Changes that affect the resource. More...

enum	BaseChanges { kLabelChanged, kResourceChanged, kNumBaseChanges }
	All ResourceHolders derived from this should start their own change enums from kNumBaseChanges. More...

Public Member Functions
	ShaderProgram (const ShaderInputRegistryPtr &registry)
	A valid ShaderInputRegistryPtr must be passed to the constructor. More...

const ShaderInputRegistryPtr &	GetRegistry () const
	Returns the ShaderInputRegistry used for the instance. More...

void	SetVertexShader (const ShaderPtr &shader)
	Sets/returns the vertex shader stage. More...

const ShaderPtr &	GetVertexShader () const

void	SetFragmentShader (const ShaderPtr &shader)
	Sets/returns the fragment shader stage. More...

const ShaderPtr &	GetFragmentShader () const

void	SetConcurrent (bool value)
	Sets/returns whether this shader program should have per-thread state. More...

bool	IsConcurrent () const

void	SetDocString (const std::string &s)
	Sets/returns a string documenting the shader program for help. More...

const std::string &	GetDocString () const

void	SetInfoLog (const std::string &info_log) const
	Sets/returns the latest info log. More...

const std::string	GetInfoLog () const

void	SetResource (size_t index, ResourceKey key, ResourceBase *resource) const
	Sets the resource at the passed index and key. More...

ResourceBase *	GetResource (size_t index, ResourceKey key) const
	Returns the Resource at the given index and key, or NULL if no resource was previously set at that location. More...

int	GetResourceCount () const
	Returns the number of resources that this holder holds. More...

size_t	GetGpuMemoryUsed () const
	Returns the total amount of GPU memory used by this Holder's resource. More...

const std::string &	GetLabel () const
	Returns/sets the label of this. More...

void	SetLabel (const std::string &label)

void	AddReceiver (Notifier *receiver)
	Adds a Notifier to be notified. More...

void	RemoveReceiver (Notifier *receiver)
	Removes a Notifier to be notified. More...

size_t	GetReceiverCount () const
	Returns the number of Notifiers that will be notified. More...

const AllocatorPtr &	GetAllocator () const
	Returns the Allocator that was used for the instance. More...

const AllocatorPtr &	GetNonNullAllocator () const
	Return our allocator, or the default allocator if the instance was declared on the stack. More...

const AllocatorPtr &	GetAllocatorForLifetime (AllocationLifetime lifetime) const
	Convenience function that returns the Allocator to use to allocate an object with a specific lifetime. More...

void *	operator new (size_t size)
	The standard no-parameter new operator uses the default Allocator. More...

void *	operator new (size_t size, AllocationLifetime lifetime)
	This overloaded version of the new operator uses the AllocationManager's default Allocator for the specified lifetime. More...

void *	operator new (size_t size, const AllocatorPtr &allocator)
	This overloaded version of the new operator takes the Allocator to use directly as a parameter. More...

void *	operator new (size_t size, const AllocatorPtr &allocator, void *ptr)
	Special operator new for using placement new with Allocatables. More...

void *	operator new (size_t size, void *ptr)
	The placement new operator is defined conventionally. More...

void	operator delete (void *ptr)
	Define the delete operator to use specialized functions dealing with an Allocator. More...

void	operator delete (void *ptr, AllocationLifetime lifetime)
	Windows requires these (or it issues C4291 warnings). More...

void	operator delete (void *ptr, const AllocatorPtr &allocator)

void	operator delete (void ptr, void ptr2)
	The placement delete operator does nothing, as usual. More...

int	GetRefCount () const
	GetRefCount() is part of the interface necessary for SharedPtr. More...

Static Public Member Functions
static const ShaderProgramPtr	BuildFromStrings (const std::string &id_string, const ShaderInputRegistryPtr &registry_ptr, const std::string &vertex_shader_string, const std::string &fragment_shader_string, const base::AllocatorPtr &allocator)
	Convenience function that builds and returns a new ShaderProgram instance that uses the given ShaderInputRegistry and that points to new vertex and fragment Shader instances whose sources are specified as strings. More...

Protected Types
typedef WeakReferentPtr< Notifier >	NotifierPtr

typedef AllocVector< NotifierPtr >	NotifierPtrVector

Protected Member Functions
	~ShaderProgram () override
	The destructor is protected because all base::Referent classes must have protected or private destructors. More...

void	OnChanged (int bit) const
	Forwards OnChanged to all resources. More...

const NotifierPtrVector &	GetReceivers () const
	Returns the set of Notifiers that will be notified. More...

void	Notify () const
	Notifies all contained Notifiers by calling their OnNotify(). More...

Detailed Description

A ShaderProgram represents an OpenGL shader program that can be applied to shapes.

It contains vertex and fragments shaders.

Definition at line 38 of file shaderprogram.h.

Member Typedef Documentation

typedef WeakReferentPtr<Notifier> ion::base::Notifier::NotifierPtr

protectedinherited

Definition at line 49 of file notifier.h.

typedef AllocVector<NotifierPtr> ion::base::Notifier::NotifierPtrVector

protectedinherited

Definition at line 50 of file notifier.h.

Member Enumeration Documentation

enum ion::gfx::ResourceHolder::BaseChanges

inherited

All ResourceHolders derived from this should start their own change enums from kNumBaseChanges.

Enumerator
kLabelChanged
kResourceChanged
kNumBaseChanges

Definition at line 56 of file resourceholder.h.

enum ion::gfx::ShaderProgram::Changes

Changes that affect the resource.

Enumerator
kVertexShaderChanged
kFragmentShaderChanged
kNumChanges

Definition at line 41 of file shaderprogram.h.

Constructor & Destructor Documentation

ion::gfx::ShaderProgram::ShaderProgram ( const ShaderInputRegistryPtr & registry )

explicit

A valid ShaderInputRegistryPtr must be passed to the constructor.

Definition at line 25 of file shaderprogram.cc.

References DCHECK, and ion::base::SharedPtr< T >::Get().

Referenced by BuildFromStrings().

ion::gfx::ShaderProgram::~ShaderProgram ( )

overrideprotected

The destructor is protected because all base::Referent classes must have protected or private destructors.

Definition at line 34 of file shaderprogram.cc.

Member Function Documentation

void ion::base::Notifier::AddReceiver ( Notifier * receiver )

inherited

Adds a Notifier to be notified.

Does nothing if the receiver is NULL or is already in the receiver vector.

Definition at line 25 of file notifier.cc.

const ShaderProgramPtr ion::gfx::ShaderProgram::BuildFromStrings	(	const std::string &	id_string,
		const ShaderInputRegistryPtr &	registry_ptr,
		const std::string &	vertex_shader_string,
		const std::string &	fragment_shader_string,
		const base::AllocatorPtr &	allocator
	)

static

Convenience function that builds and returns a new ShaderProgram instance that uses the given ShaderInputRegistry and that points to new vertex and fragment Shader instances whose sources are specified as strings.

The ShaderProgram's label is set to id_string, the vertex Shader's label is set to id_string + " vertex shader", and the fragment Shader's label is set to id_string + " fragment shader". The allocator is used for the ShaderProgram and both Shaders.

Definition at line 41 of file shaderprogram.cc.

References ShaderProgram().

const AllocatorPtr& ion::base::Allocatable::GetAllocator ( ) const

inlineinherited

Returns the Allocator that was used for the instance.

This will be NULL if the instance was declared on the stack or created with normal placement new.

Definition at line 68 of file allocatable.h.

References allocator_.

Referenced by ion::base::DataContainer::CreateAndCopy(), ion::text::DynamicFontImage::FindContainingImageDataIndex(), and ion::text::DynamicFontImage::FindImageDataIndex().

const AllocatorPtr& ion::base::Allocatable::GetAllocatorForLifetime ( AllocationLifetime lifetime ) const

inlineinherited

Convenience function that returns the Allocator to use to allocate an object with a specific lifetime.

Definition at line 78 of file allocatable.h.

References ion::base::Allocator::GetAllocatorForLifetime().

Referenced by ion::text::BasicBuilder::BuildVertexData(), ion::text::OutlineBuilder::BuildVertexData(), ion::gfxutils::ShaderManager::CreateShaderProgram(), ion::text::DynamicFontImage::FindContainingImageDataIndex(), ion::text::DynamicFontImage::FindImageDataIndex(), ion::gfx::Renderer::Renderer(), and ion::gfx::UpdateStateTable().

const std::string& ion::gfx::ShaderBase::GetDocString ( ) const

inlineinherited

Definition at line 34 of file shader.h.

const ShaderPtr& ion::gfx::ShaderProgram::GetFragmentShader ( ) const

inline

Definition at line 73 of file shaderprogram.h.

References ion::base::SharedPtr< T >::Get().

size_t ion::gfx::ResourceHolder::GetGpuMemoryUsed ( ) const

inlineinherited

Returns the total amount of GPU memory used by this Holder's resource.

Definition at line 78 of file resourceholder.h.

const std::string ion::gfx::ShaderBase::GetInfoLog ( ) const

inlineinherited

Definition at line 40 of file shader.h.

const std::string& ion::gfx::ResourceHolder::GetLabel ( ) const

inlineinherited

Returns/sets the label of this.

Definition at line 89 of file resourceholder.h.

const AllocatorPtr& ion::base::Allocatable::GetNonNullAllocator ( ) const

inlineinherited

Return our allocator, or the default allocator if the instance was declared on the stack.

Definition at line 72 of file allocatable.h.

References allocator_, and ion::base::AllocationManager::GetNonNullAllocator().

size_t ion::base::Notifier::GetReceiverCount ( ) const

inherited

Returns the number of Notifiers that will be notified.

Definition at line 71 of file notifier.cc.

const Notifier::NotifierPtrVector & ion::base::Notifier::GetReceivers ( ) const

protectedinherited

Returns the set of Notifiers that will be notified.

Definition at line 77 of file notifier.cc.

int ion::base::Shareable::GetRefCount ( ) const

inlineinherited

GetRefCount() is part of the interface necessary for SharedPtr.

Definition at line 34 of file shareable.h.

Referenced by ion::base::Notifier::RemoveReceiver().

const ShaderInputRegistryPtr& ion::gfx::ShaderProgram::GetRegistry ( ) const

inline

Returns the ShaderInputRegistry used for the instance.

Definition at line 51 of file shaderprogram.h.

ResourceBase * ion::gfx::ResourceHolder::GetResource	(	size_t	index,
		ResourceKey	key
	)		const

inherited

Returns the Resource at the given index and key, or NULL if no resource was previously set at that location.

Definition at line 122 of file resourceholder.cc.

int ion::gfx::ResourceHolder::GetResourceCount ( ) const

inlineinherited

Returns the number of resources that this holder holds.

Note that this is not necessarily the number of indices that have non-NULL resources. This can be used as a fast trivial check to see if the holder has any resources.

Definition at line 73 of file resourceholder.h.

const ShaderPtr& ion::gfx::ShaderProgram::GetVertexShader ( ) const

inline

Definition at line 61 of file shaderprogram.h.

References ion::base::SharedPtr< T >::Get().

bool ion::gfx::ShaderProgram::IsConcurrent ( ) const

inline

Definition at line 89 of file shaderprogram.h.

Referenced by ion::gfx::Renderer::ResourceManager::GetResourceKey< Renderer::ShaderProgramResource >().

void ion::base::Notifier::Notify ( ) const

protectedinherited

Notifies all contained Notifiers by calling their OnNotify().

Any receivers that have been destroyed will be removed from the vector of receivers.

Definition at line 81 of file notifier.cc.

References ion::base::SharedPtr< T >::Get().

void ion::gfx::ResourceHolder::OnChanged ( int bit ) const

inlineprotectedinherited

Forwards OnChanged to all resources.

Definition at line 326 of file resourceholder.h.

void ion::base::Allocatable::operator delete ( void * ptr )

inlineinherited

Define the delete operator to use specialized functions dealing with an Allocator.

Definition at line 109 of file allocatable.h.

void ion::base::Allocatable::operator delete	(	void *	ptr,
		AllocationLifetime	lifetime
	)

inlineinherited

Windows requires these (or it issues C4291 warnings).

Definition at line 112 of file allocatable.h.

void ion::base::Allocatable::operator delete	(	void *	ptr,
		const AllocatorPtr &	allocator
	)

inlineinherited

Definition at line 113 of file allocatable.h.

void ion::base::Allocatable::operator delete	(	void *	ptr,
		void *	ptr2
	)

inlineinherited

The placement delete operator does nothing, as usual.

Definition at line 118 of file allocatable.h.

void* ion::base::Allocatable::operator new ( size_t size )

inlineinherited

The standard no-parameter new operator uses the default Allocator.

Definition at line 84 of file allocatable.h.

void* ion::base::Allocatable::operator new	(	size_t	size,
		AllocationLifetime	lifetime
	)

inlineinherited

This overloaded version of the new operator uses the AllocationManager's default Allocator for the specified lifetime.

Definition at line 88 of file allocatable.h.

void* ion::base::Allocatable::operator new	(	size_t	size,
		const AllocatorPtr &	allocator
	)

inlineinherited

This overloaded version of the new operator takes the Allocator to use directly as a parameter.

If the Allocator pointer is NULL, this uses the default Allocator.

Definition at line 95 of file allocatable.h.

void* ion::base::Allocatable::operator new	(	size_t	size,
		const AllocatorPtr &	allocator,
		void *	ptr
	)

inlineinherited

Special operator new for using placement new with Allocatables.

Definition at line 100 of file allocatable.h.

void* ion::base::Allocatable::operator new	(	size_t	size,
		void *	ptr
	)

inlineinherited

The placement new operator is defined conventionally.

Definition at line 105 of file allocatable.h.

void ion::base::Notifier::RemoveReceiver ( Notifier * receiver )

inherited

Removes a Notifier to be notified.

Does nothing if the receiver is NULL or not in the set of receivers.

Definition at line 38 of file notifier.cc.

References ion::base::Shareable::GetRefCount().

Referenced by ion::gfx::AttributeArray::~AttributeArray().

void ion::gfx::ShaderProgram::SetConcurrent ( bool value )

Sets/returns whether this shader program should have per-thread state.

When this is enabled, it is possible to simultaneously set different uniform values and attribute bindings in each thread, allowing one to concurrently render the same scene from several different viewpoints or render two different objects in two different threads using the same shader program. However, a new OpenGL program object is created for each rendering thread that uses this shader program, which consumes more GPU memory. After this function is called, subsequent calls cannot pass a different value. By default, this setting is disabled, mirroring the behavior of OpenGL.

Definition at line 67 of file shaderprogram.cc.

References LOG, value, and ion::port::WARNING.

Referenced by ion::gfx::Renderer::ResourceManager::GetResourceKey< Renderer::ShaderProgramResource >().

void ion::gfx::ShaderBase::SetDocString ( const std::string & s )

inlineinherited

Sets/returns a string documenting the shader program for help.

Definition at line 33 of file shader.h.

void ion::gfx::ShaderProgram::SetFragmentShader ( const ShaderPtr & shader )

inline

Sets/returns the fragment shader stage.

Definition at line 66 of file shaderprogram.h.

References ion::base::SharedPtr< T >::Get().

void ion::gfx::ShaderBase::SetInfoLog ( const std::string & info_log ) const

inlineinherited

Sets/returns the latest info log.

Definition at line 37 of file shader.h.

void ion::gfx::ResourceHolder::SetLabel ( const std::string & label )

inlineinherited

Definition at line 90 of file resourceholder.h.

void ion::gfx::ResourceHolder::SetResource	(	size_t	index,
		ResourceKey	key,
		ResourceBase *	resource
	)		const

inherited

Sets the resource at the passed index and key.

The size of the internal vector is automatically managed so that it has the smallest possible size.

Definition at line 51 of file resourceholder.cc.

References DCHECK, DCHECK_EQ, ion::gfx::ResourceBase::GetKey(), and ion::gfx::ResourceBase::OnChanged().

void ion::gfx::ShaderProgram::SetVertexShader ( const ShaderPtr & shader )

inline

Sets/returns the vertex shader stage.

Definition at line 54 of file shaderprogram.h.

References ion::base::SharedPtr< T >::Get().

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

gfx/shaderprogram.h
gfx/shaderprogram.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation