OGRE  13.4
Object-Oriented Graphics Rendering Engine
Ogre::GLSL::GLSLProgram Class Reference

#include <OgreGLSLProgram.h>

+ Inheritance diagram for Ogre::GLSL::GLSLProgram:

Public Member Functions

 GLSLProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader)
 
 ~GLSLProgram ()
 
void attachToProgramObject (const uint programObject)
 
void bindProgram ()
 Execute the binding functions for this program. More...
 
void bindProgramParameters (GpuProgramParametersSharedPtr params, uint16 mask)
 Execute the param binding functions for this program. More...
 
void detachFromProgramObject (const uint programObject)
 
RenderOperation::OperationType getInputOperationType (void) const
 Returns the operation type that this geometry program expects to receive as input. More...
 
const StringgetLanguage (void) const
 Overridden from GpuProgram. More...
 
int getMaxOutputVertices (void) const
 Returns the maximum number of vertices that this geometry program can output in a single run. More...
 
RenderOperation::OperationType getOutputOperationType (void) const
 Returns the operation type that this geometry program will emit. More...
 
bool getPassFogStates (void) const
 Returns whether a fragment program wants fog state to be passed through fixed pipeline low level API rendering calls (default true, subclasses can override) More...
 
bool getPassSurfaceAndLightStates (void) const
 Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls (default false, subclasses can override) More...
 
bool getPassTransformStates (void) const
 Returns whether a vertex program wants transform state to be passed through fixed pipeline low level API rendering calls. More...
 
bool isAttributeValid (VertexElementSemantic semantic, uint index)
 Test whether attribute index for a given semantic is valid. More...
 
void setInputOperationType (RenderOperation::OperationType operationType)
 Sets the operation type that this geometry program expects to receive. More...
 
void setMaxOutputVertices (int maxOutputVertices)
 Set the maximum number of vertices that a single run of this geometry program can emit. More...
 
void setOutputOperationType (RenderOperation::OperationType operationType)
 Set the operation type that this geometry program will emit. More...
 
void unbindProgram ()
 Execute the binding functions for this program. More...
 
- Public Member Functions inherited from Ogre::GLSLShaderCommon
 GLSLShaderCommon (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader)
 
GpuProgram_getBindingDelegate (void)
 GLSL does not provide access to the low level code of the shader, so use this shader for binding as well. More...
 
void attachChildShader (const String &name)
 Overridden. More...
 
String getAttachedShaderNames () const
 
bool getColumnMajorMatrices (void) const
 Gets whether matrix packed in column-major order. More...
 
uint getGLProgramHandle () const
 If we are using program pipelines, the OpenGL program handle. More...
 
uint getShaderID (void) const
 Get the OGRE assigned shader ID. More...
 
GLUniformCachegetUniformCache ()
 Get the uniform cache for this shader. More...
 
virtual bool linkSeparable ()
 Only used for separable programs. More...
 
void resetLinked ()
 reset link status of separable program More...
 
void setColumnMajorMatrices (bool columnMajor)
 Sets whether matrix packing in column-major order. More...
 
- Public Member Functions inherited from Ogre::HighLevelGpuProgram
 HighLevelGpuProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)
 Constructor, should be used only by factory classes. More...
 
 ~HighLevelGpuProgram ()
 
virtual size_t calculateSize (void) const
 Calculate the size of a resource; this will only be called after 'load'. More...
 
GpuProgramParametersSharedPtr createParameters (void)
 Creates a new parameters object compatible with this program definition. More...
 
const GpuNamedConstantsgetConstantDefinitions () override
 Get the full list of GpuConstantDefinition instances. More...
 
const StringgetEntryPoint (void) const
 Gets the entry point defined for this program. More...
 
const StringgetPreprocessorDefines (void) const
 Gets the preprocessor defines used to compile the program. More...
 
void setEntryPoint (const String &entryPoint)
 Sets the entry point for this program i.e, the first method called. More...
 
void setPreprocessorDefines (const String &defines)
 Sets the preprocessor defines used to compile the program. More...
 
- Public Member Functions inherited from Ogre::GpuProgram
 GpuProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)
 
virtual ~GpuProgram ()
 
uint32 _getHash (uint32 seed=0) const
 internal method to get the microcode cache id More...
 
virtual const GpuProgramParametersPtrgetDefaultParameters (void)
 Get a reference to the default parameters which are to be used for all uses of this program. More...
 
const StringgetManualNamedConstantsFile () const
 Gets the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself. More...
 
virtual ushort getNumberOfPosesIncluded (void) const
 Returns the number of simultaneous poses the vertex program can blend, for use in pose animation. More...
 
virtual const StringgetSource (void) const
 Gets the assembler source for this program. More...
 
const StringgetSourceFile (void) const
 Gets the name of the file used as source for this program. More...
 
const StringgetSyntaxCode (void) const
 Gets the syntax code for this program e.g. More...
 
GpuProgramType getType (void) const
 Get the program type. More...
 
virtual bool hasCompileError (void) const
 Did this program encounter a compile error when loading? More...
 
virtual bool hasDefaultParameters (void) const
 Returns true if default parameters have been set up. More...
 
virtual bool isAdjacencyInfoRequired (void) const
 
virtual bool isMorphAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform morph animation. More...
 
virtual bool isPoseAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform pose animation. More...
 
virtual bool isSkeletalAnimationIncluded (void) const
 Returns whether a vertex program includes the required instructions to perform skeletal animation. More...
 
virtual bool isSupported (void) const
 Returns whether this program can be supported on the current renderer and hardware. More...
 
virtual bool isVertexTextureFetchRequired (void) const
 Returns whether this vertex program requires support for vertex texture fetch from the hardware. More...
 
virtual void resetCompileError (void)
 Reset a compile error if it occurred, allowing the load to be retried. More...
 
virtual void setAdjacencyInfoRequired (bool r)
 
void setManualNamedConstants (const GpuNamedConstants &namedConstants)
 Allows you to manually provide a set of named parameter mappings to a program which would not be able to derive named parameters itself. More...
 
void setManualNamedConstantsFile (const String &paramDefFile)
 Specifies the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself. More...
 
virtual void setMorphAnimationIncluded (bool included)
 Sets whether a vertex program includes the required instructions to perform morph animation. More...
 
virtual void setPoseAnimationIncluded (ushort poseCount)
 Sets whether a vertex program includes the required instructions to perform pose animation. More...
 
virtual void setSkeletalAnimationIncluded (bool included)
 Sets whether a vertex program includes the required instructions to perform skeletal animation. More...
 
void setSource (const String &source)
 Sets the source assembly for this program from an in-memory string. More...
 
void setSourceFile (const String &filename)
 Sets the filename of the source assembly for this program. More...
 
void setSyntaxCode (const String &syntax)
 Sets the syntax code for this program e.g. More...
 
void setType (GpuProgramType t)
 Set the program type (only valid before load) More...
 
virtual void setVertexTextureFetchRequired (bool r)
 Sets whether this vertex program requires support for vertex texture fetch from the hardware. More...
 
- Public Member Functions inherited from Ogre::Resource
 Resource (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)
 Standard constructor. More...
 
virtual ~Resource ()
 Virtual destructor. More...
 
virtual void _dirtyState ()
 Manually mark the state of this resource as having been changed. More...
 
void _fireLoadingComplete (bool unused=false)
 Firing of loading complete event. More...
 
void _firePreparingComplete (bool unused=false)
 Firing of preparing complete event. More...
 
void _fireUnloadingComplete (void)
 Firing of unloading complete event. More...
 
void _notifyOrigin (const String &origin)
 Notify this resource of it's origin. More...
 
virtual void addListener (Listener *lis)
 Register a listener on this resource. More...
 
virtual void changeGroupOwnership (const String &newGroup)
 Change the resource group ownership of a Resource. More...
 
virtual void escalateLoading ()
 Escalates the loading of a background loaded resource. More...
 
ResourceManagergetCreator (void)
 Gets the manager which created this resource. More...
 
const StringgetGroup (void) const
 Gets the group which this resource is a member of. More...
 
ResourceHandle getHandle (void) const
 
LoadingState getLoadingState () const
 Returns the current loading state. More...
 
const StringgetName (void) const
 Gets resource name. More...
 
const StringgetOrigin (void) const
 Get the origin of this resource, e.g. More...
 
size_t getSize (void) const
 Retrieves info about the size of the resource. More...
 
virtual size_t getStateCount () const
 Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. More...
 
bool isBackgroundLoaded (void) const
 Returns whether this Resource has been earmarked for background loading. More...
 
bool isLoaded (void) const
 Returns true if the Resource has been loaded, false otherwise. More...
 
bool isLoading () const
 Returns whether the resource is currently in the process of background loading. More...
 
bool isManuallyLoaded (void) const
 Is this resource manually loaded? More...
 
bool isPrepared (void) const
 Returns true if the Resource has been prepared, false otherwise. More...
 
bool isReloadable (void) const
 Returns true if the Resource is reloadable, false otherwise. More...
 
virtual void load (bool backgroundThread=false)
 Loads the resource, if it is not already. More...
 
virtual void prepare (bool backgroundThread=false)
 Prepares the resource for load, if it is not already. More...
 
virtual void reload (LoadingFlags flags=LF_DEFAULT)
 Reloads the resource, if it is already loaded. More...
 
virtual void removeListener (Listener *lis)
 Remove a listener on this resource. More...
 
void setBackgroundLoaded (bool bl)
 Tells the resource whether it is background loaded or not. More...
 
virtual void touch (void)
 'Touches' the resource to indicate it has been used. More...
 
virtual void unload (void)
 Unloads the resource; this is not permanent, the resource can be reloaded later if required. More...
 
- Public Member Functions inherited from Ogre::StringInterface
 StringInterface ()
 
virtual ~StringInterface ()
 Virtual destructor, see Effective C++. More...
 
void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 
bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 
- Public Member Functions inherited from Ogre::GLGpuProgramBase
virtual ~GLGpuProgramBase ()
 

Additional Inherited Members

- Public Types inherited from Ogre::Resource
enum  LoadingFlags {
  LF_DEFAULT = 0 , LF_INCLUDE_NON_RELOADABLE = 1 , LF_ONLY_UNREFERENCED = 2 , LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE = 3 ,
  LF_PRESERVE_STATE = 4
}
 Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. More...
 
enum  LoadingState {
  LOADSTATE_UNLOADED , LOADSTATE_LOADING , LOADSTATE_LOADED , LOADSTATE_UNLOADING ,
  LOADSTATE_PREPARED , LOADSTATE_PREPARING
}
 Enum identifying the loading state of the resource. More...
 
- Static Public Member Functions inherited from Ogre::HighLevelGpuProgram
static String _resolveIncludes (const String &source, Resource *resourceBeingLoaded, const String &fileName, bool supportsFilename=false)
 Scan the source for #include and replace with contents from OGRE resources. More...
 
- Static Public Member Functions inherited from Ogre::GpuProgram
static const String getProgramTypeName (GpuProgramType programType)
 
- Static Public Member Functions inherited from Ogre::StringInterface
static void cleanupDictionary ()
 Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...
 

Constructor & Destructor Documentation

◆ GLSLProgram()

Ogre::GLSL::GLSLProgram::GLSLProgram ( ResourceManager creator,
const String name,
ResourceHandle  handle,
const String group,
bool  isManual,
ManualResourceLoader loader 
)

◆ ~GLSLProgram()

Ogre::GLSL::GLSLProgram::~GLSLProgram ( )

Member Function Documentation

◆ attachToProgramObject()

void Ogre::GLSL::GLSLProgram::attachToProgramObject ( const uint  programObject)
virtual

◆ detachFromProgramObject()

void Ogre::GLSL::GLSLProgram::detachFromProgramObject ( const uint  programObject)
virtual

◆ getLanguage()

const String& Ogre::GLSL::GLSLProgram::getLanguage ( void  ) const
virtual

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

◆ getPassTransformStates()

bool Ogre::GLSL::GLSLProgram::getPassTransformStates ( void  ) const
inlinevirtual

Returns whether a vertex program wants transform state to be passed through fixed pipeline low level API rendering calls.

Most vertex programs do not need fixed-function transform information, however GLSL shaders can refer to this state so enable this option

Reimplemented from Ogre::GpuProgram.

◆ getPassSurfaceAndLightStates()

bool Ogre::GLSL::GLSLProgram::getPassSurfaceAndLightStates ( void  ) const
inlinevirtual

Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls (default false, subclasses can override)

Most vertex programs do not need this material information, however GLSL shaders can refer to this material and lighting state so enable this option

Reimplemented from Ogre::GpuProgram.

◆ getPassFogStates()

bool Ogre::GLSL::GLSLProgram::getPassFogStates ( void  ) const
inlinevirtual

Returns whether a fragment program wants fog state to be passed through fixed pipeline low level API rendering calls (default true, subclasses can override)

On DirectX, shader model 2 and earlier continues to have fixed-function fog applied to it, so fog state is still passed (you should disable fog on the pass if you want to perform fog in the shader). In OpenGL it is also common to be able to access the fixed-function fog state inside the shader.

Reimplemented from Ogre::GpuProgram.

◆ getInputOperationType()

RenderOperation::OperationType Ogre::GLSL::GLSLProgram::getInputOperationType ( void  ) const
inline

Returns the operation type that this geometry program expects to receive as input.

◆ getOutputOperationType()

RenderOperation::OperationType Ogre::GLSL::GLSLProgram::getOutputOperationType ( void  ) const
inline

Returns the operation type that this geometry program will emit.

◆ getMaxOutputVertices()

int Ogre::GLSL::GLSLProgram::getMaxOutputVertices ( void  ) const
inline

Returns the maximum number of vertices that this geometry program can output in a single run.

◆ setInputOperationType()

void Ogre::GLSL::GLSLProgram::setInputOperationType ( RenderOperation::OperationType  operationType)
inline

Sets the operation type that this geometry program expects to receive.

◆ setOutputOperationType()

void Ogre::GLSL::GLSLProgram::setOutputOperationType ( RenderOperation::OperationType  operationType)
inline

◆ setMaxOutputVertices()

void Ogre::GLSL::GLSLProgram::setMaxOutputVertices ( int  maxOutputVertices)
inline

Set the maximum number of vertices that a single run of this geometry program can emit.

◆ bindProgram()

void Ogre::GLSL::GLSLProgram::bindProgram ( )
virtual

Execute the binding functions for this program.

Implements Ogre::GLGpuProgramBase.

◆ unbindProgram()

void Ogre::GLSL::GLSLProgram::unbindProgram ( )
virtual

Execute the binding functions for this program.

Implements Ogre::GLGpuProgramBase.

◆ bindProgramParameters()

void Ogre::GLSL::GLSLProgram::bindProgramParameters ( GpuProgramParametersSharedPtr  params,
uint16  mask 
)
virtual

Execute the param binding functions for this program.

Implements Ogre::GLGpuProgramBase.

◆ isAttributeValid()

bool Ogre::GLSL::GLSLProgram::isAttributeValid ( VertexElementSemantic  semantic,
uint  index 
)
virtual

Test whether attribute index for a given semantic is valid.

Reimplemented from Ogre::GLGpuProgramBase.


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