OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::GpuProgramUsage Class Reference

This class makes the usage of a vertex and fragment programs (low-level or high-level), with a given set of parameters, explicit. More...

#include <OgreGpuProgramUsage.h>

+ Inheritance diagram for Ogre::GpuProgramUsage:
+ Collaboration diagram for Ogre::GpuProgramUsage:

Public Member Functions

 GpuProgramUsage (GpuProgramType gptype, Pass *parent)
 Default constructor. More...
 
 GpuProgramUsage (const GpuProgramUsage &rhs, Pass *newparent)
 Copy constructor. More...
 
 ~GpuProgramUsage ()
 
void _load (void)
 Load this usage (and ensure program is loaded) More...
 
void _unload (void)
 Unload this usage. More...
 
size_t calculateSize (void) const
 
GpuProgramParametersSharedPtr getParameters (void)
 Gets the parameters being used here. More...
 
const GpuProgramPtrgetProgram () const
 Gets the program being used. More...
 
const StringgetProgramName (void) const
 Gets the program being used. More...
 
GpuProgramType getType (void) const
 Gets the type of program we're trying to link to. More...
 
void loadingComplete (Resource *prog)
 Called whenever the resource finishes loading. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void preparingComplete (Resource *)
 Called whenever the resource finishes preparing (paging into memory). More...
 
void setParameters (GpuProgramParametersSharedPtr params)
 Sets the program parameters that should be used; because parameters can be shared between multiple usages for efficiency, this method is here for you to register externally created parameter objects. More...
 
void setProgram (GpuProgramPtr &prog)
 Sets the program to use. More...
 
void setProgramName (const String &name, bool resetParams=true)
 Sets the name of the program to use. More...
 
void unloadingComplete (Resource *prog)
 Called whenever the resource has been unloaded. More...
 

Protected Member Functions

void recreateParameters ()
 

Protected Attributes

GpuProgramParametersSharedPtr mParameters
 Program parameters. More...
 
PassmParent
 
GpuProgramPtr mProgram
 The program link. More...
 
bool mRecreateParams
 Whether to recreate parameters next load. More...
 
GpuProgramType mType
 

Detailed Description

This class makes the usage of a vertex and fragment programs (low-level or high-level), with a given set of parameters, explicit.

Remarks
Using a vertex or fragment program can get fairly complex; besides the fairly rudimentary process of binding a program to the GPU for rendering, managing usage has few complications, such as:
  • Programs can be high level (e.g. Cg, RenderMonkey) or low level (assembler). Using either should be relatively seamless, although high-level programs give you the advantage of being able to use named parameters, instead of just indexed registers
  • Programs and parameters can be shared between multiple usages, in order to save memory
  • When you define a user of a program, such as a material, you often want to be able to set up the definition but not load / compile / assemble the program at that stage, because it is not needed just yet. The program should be loaded when it is first needed, or earlier if specifically requested. The program may not be defined at this time, you may want to have scripts that can set up the definitions independent of the order in which those scripts are loaded.
This class packages up those details so you don't have to worry about them. For example, this class lets you define a high-level program and set up the parameters for it, without having loaded the program (which you normally could not do). When the program is loaded and compiled, this class will then validate the parameters you supplied earlier and turn them into runtime parameters.
Just incase it wasn't clear from the above, this class provides linkage to both GpuProgram and HighLevelGpuProgram, despite its name.

Definition at line 73 of file OgreGpuProgramUsage.h.

Constructor & Destructor Documentation

Ogre::GpuProgramUsage::GpuProgramUsage ( GpuProgramType  gptype,
Pass parent 
)

Default constructor.

Parameters
gptypeThe type of program to link to
Ogre::GpuProgramUsage::GpuProgramUsage ( const GpuProgramUsage rhs,
Pass newparent 
)

Copy constructor.

Ogre::GpuProgramUsage::~GpuProgramUsage ( )

Member Function Documentation

void Ogre::GpuProgramUsage::_load ( void  )

Load this usage (and ensure program is loaded)

void Ogre::GpuProgramUsage::_unload ( void  )

Unload this usage.

size_t Ogre::GpuProgramUsage::calculateSize ( void  ) const
GpuProgramParametersSharedPtr Ogre::GpuProgramUsage::getParameters ( void  )

Gets the parameters being used here.

const GpuProgramPtr& Ogre::GpuProgramUsage::getProgram ( ) const
inline

Gets the program being used.

Definition at line 122 of file OgreGpuProgramUsage.h.

const String& Ogre::GpuProgramUsage::getProgramName ( void  ) const
inline

Gets the program being used.

Definition at line 124 of file OgreGpuProgramUsage.h.

GpuProgramType Ogre::GpuProgramUsage::getType ( void  ) const
inline

Gets the type of program we're trying to link to.

Definition at line 101 of file OgreGpuProgramUsage.h.

void Ogre::GpuProgramUsage::loadingComplete ( Resource )
virtual

Called whenever the resource finishes loading.

Remarks
If a Resource has been marked as background loaded (
See also
Resource::setBackgroundLoaded), the call does not itself occur in the thread which is doing the loading; when loading is complete a response indicator is placed with the ResourceGroupManager, which will then be sent back to the listener as part of the application's primary frame loop thread.

Reimplemented from Ogre::Resource::Listener.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::Resource::Listener::preparingComplete ( Resource )
inlinevirtualinherited

Called whenever the resource finishes preparing (paging into memory).

Remarks
If a Resource has been marked as background loaded (
See also
Resource::setBackgroundLoaded) the call does not itself occur in the thread which is doing the preparing; when preparing is complete a response indicator is placed with the ResourceGroupManager, which will then be sent back to the listener as part of the application's primary frame loop thread.

Definition at line 108 of file OgreResource.h.

void Ogre::GpuProgramUsage::recreateParameters ( )
protected
void Ogre::GpuProgramUsage::setParameters ( GpuProgramParametersSharedPtr  params)

Sets the program parameters that should be used; because parameters can be shared between multiple usages for efficiency, this method is here for you to register externally created parameter objects.

Otherwise, the parameters will be created for you when a program is linked.

void Ogre::GpuProgramUsage::setProgram ( GpuProgramPtr prog)

Sets the program to use.

Remarks
Note that this will create a fresh set of parameters from the new program being linked, so if you had previously set parameters you will have to set them again.
void Ogre::GpuProgramUsage::setProgramName ( const String name,
bool  resetParams = true 
)

Sets the name of the program to use.

Parameters
nameThe name of the program to use
resetParamsIf true, this will create a fresh set of parameters from the new program being linked, so if you had previously set parameters you will have to set them again. If you set this to false, you must be absolutely sure that the parameters match perfectly, and in the case of named parameters refers to the indexes underlying them, not just the names.
void Ogre::GpuProgramUsage::unloadingComplete ( Resource )
virtual

Called whenever the resource has been unloaded.

Reimplemented from Ogre::Resource::Listener.

Member Data Documentation

GpuProgramParametersSharedPtr Ogre::GpuProgramUsage::mParameters
protected

Program parameters.

Definition at line 82 of file OgreGpuProgramUsage.h.

Pass* Ogre::GpuProgramUsage::mParent
protected

Definition at line 77 of file OgreGpuProgramUsage.h.

GpuProgramPtr Ogre::GpuProgramUsage::mProgram
protected

The program link.

Definition at line 79 of file OgreGpuProgramUsage.h.

bool Ogre::GpuProgramUsage::mRecreateParams
protected

Whether to recreate parameters next load.

Definition at line 85 of file OgreGpuProgramUsage.h.

GpuProgramType Ogre::GpuProgramUsage::mType
protected

Definition at line 76 of file OgreGpuProgramUsage.h.


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