 |
OGRE 14.3
Object-Oriented Graphics Rendering Engine
|
|
OGRE 14.3
Object-Oriented Graphics Rendering Engine
|
This is the same technique the old InstancedGeometry implementation used (with improvements). More...
#include <OgreInstanceBatchShader.h>
Inheritance diagram for Ogre::InstanceBatchShader:Public Member Functions | |
| InstanceBatchShader (InstanceManager *creator, MeshPtr &meshReference, const MaterialPtr &material, size_t instancesPerBatch, const Mesh::IndexMap *indexToBoneMap, const String &batchName) | |
| void | buildFrom (const SubMesh *baseSubMesh, const RenderOperation &renderOperation) override |
| size_t | calculateMaxNumInstances (const SubMesh *baseSubMesh, uint16 flags) const override |
| unsigned short | getNumWorldTransforms (void) const override |
| Returns the number of world transform matrices this renderable requires. | |
| void | getWorldTransforms (Matrix4 *xform) const override |
| Gets the world transform matrix / matrices for this renderable object. | |
| Public Member Functions inherited from Ogre::InstanceBatch | |
| InstanceBatch (InstanceManager *creator, MeshPtr &meshReference, const MaterialPtr &material, size_t instancesPerBatch, const Mesh::IndexMap *indexToBoneMap, const String &batchName) | |
| virtual | ~InstanceBatch () |
| virtual void | _boundsDirty (void) |
| Called by InstancedEntity(s) to tell us we need to update the bounds (we touch the SceneNode so the SceneManager aknowledges such change) | |
| void | _defragmentBatch (bool optimizeCulling, InstancedEntityVec &usedEntities, CustomParamsVec &usedParams) |
| void | _defragmentBatchDiscard (void) |
| const Vector4f & | _getCustomParam (InstancedEntity *instancedEntity, unsigned char idx) |
| const Mesh::IndexMap * | _getIndexToBoneMap () const |
| MeshPtr & | _getMeshRef () |
| const Ogre::MeshPtr & | _getMeshReference (void) const |
| void | _markTransformSharingDirty () |
| Tells that the list of entity instances with shared transforms has changed. | |
| void | _notifyCurrentCamera (Camera *cam) override |
| Internal method to notify the object of the camera to be used for the next rendering operation. | |
| void | _setCustomParam (InstancedEntity *instancedEntity, unsigned char idx, const Vector4f &newParam) |
| void | _setInstancesPerBatch (size_t instancesPerBatch) |
| Raises an exception if trying to change it after being built. | |
| bool | _supportsSkeletalAnimation () const |
| Returns true if this technique supports skeletal animation. | |
| void | _updateBounds (void) |
| void | _updateRenderQueue (RenderQueue *queue) override |
| Internal method by which the movable object must add Renderable subclass instances to the rendering queue. | |
| virtual RenderOperation | build (const SubMesh *baseSubMesh) |
| Constructs all the data needed to use this batch, as well as the InstanceEntities. | |
| InstancedEntity * | createInstancedEntity () |
| Returns a pointer to a new InstancedEntity ready to use Note it's actually preallocated, so no memory allocation happens at this point. | |
| const AxisAlignedBox & | getBoundingBox (void) const override |
| Retrieves the local axis-aligned bounding box for this object. | |
| Real | getBoundingRadius (void) const override |
| Retrieves the radius of the origin-centered bounding sphere for this object. | |
| void | getInstancedEntitiesInUse (InstancedEntityVec &outEntities, CustomParamsVec &outParams) |
| Fills the input vector with the instances that are currently being used or were requested. | |
| const LightList & | getLights (void) const override |
| Gets a list of lights, ordered relative to how close they are to this renderable. | |
| const MaterialPtr & | getMaterial (void) const override |
| Retrieves a weak reference to the material this renderable object uses. | |
| const String & | getMovableType (void) const override |
| Returns the type name of this object. | |
| void | getRenderOperation (RenderOperation &op) override |
| Gets the render operation required to send this object to the frame buffer. | |
| Real | getSquaredViewDepth (const Camera *cam) const override |
| Returns the squared distance between the camera and this renderable. | |
| const Any & | getUserAny (void) const |
| bool | isBatchFull (void) const |
| bool | isBatchUnused (void) const |
| Returns true if it no instanced entity has been requested or all of them have been removed. | |
| virtual bool | isStatic () const |
| Returns true if this batch was set as static. | |
| void | removeInstancedEntity (InstancedEntity *instancedEntity) |
| Removes an InstancedEntity from the scene retrieved with getNewInstancedEntity, putting back into a queue. | |
| virtual void | setStaticAndUpdate (bool bStatic) |
| Tells this batch to stop updating animations, positions, rotations, and display all it's active instances. | |
| void | setUserAny (const Any &anything) |
| virtual bool | useBoneWorldMatrices () const |
| Tells whether world bone matrices need to be calculated. | |
| void | visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false) override |
| Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. | |
| Public Member Functions inherited from Ogre::Renderable | |
| Renderable () | |
| virtual | ~Renderable () |
| Virtual destructor needed as class has virtual methods. | |
| uint16 | _getMaterialLodIndex () const |
| virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const |
| Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. | |
| virtual bool | getCastsShadows (void) const |
| Method which reports whether this renderable would normally cast a shadow. | |
| const Vector4f & | getCustomParameter (size_t index) const |
| Gets the custom value associated with this Renderable at the given index. | |
| bool | getPolygonModeOverrideable (void) const |
| Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
| virtual Technique * | getTechnique (void) const |
| Retrieves a pointer to the Material Technique this renderable object uses. | |
| bool | getUseIdentityProjection (void) const |
| Returns whether or not to use an 'identity' projection. | |
| bool | getUseIdentityView (void) const |
| Returns whether or not to use an 'identity' view. | |
| const Any & | getUserAny (void) const |
| UserObjectBindings & | getUserObjectBindings () |
| Class that provides convenient interface to establish a linkage between custom user application objects and Ogre core classes. | |
| const UserObjectBindings & | getUserObjectBindings () const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| bool | hasCustomParameter (size_t index) const |
| Checks whether a custom value is associated with this Renderable at the given index. | |
| virtual void | postRender (SceneManager *sm, RenderSystem *rsys) |
| Called immediately after the Renderable has been rendered. | |
| virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) |
| Called just prior to the Renderable being rendered. | |
| void | removeCustomParameter (size_t index) |
| Removes a custom value which is associated with this Renderable at the given index. | |
| void | setCustomParameter (size_t index, const Vector4f &value) |
| Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. | |
| void | setPolygonModeOverrideable (bool override) |
| Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
| void | setUseIdentityProjection (bool useIdentityProjection) |
| Sets whether or not to use an 'identity' projection. | |
| void | setUseIdentityView (bool useIdentityView) |
| Sets whether or not to use an 'identity' view. | |
| void | setUserAny (const Any &anything) |
| Public Member Functions inherited from Ogre::MovableObject | |
| MovableObject () | |
| Constructor. | |
| MovableObject (const String &name) | |
| Named constructor. | |
| virtual | ~MovableObject () |
| Virtual destructor - read Scott Meyers if you don't know why this is needed. | |
| MovableObjectFactory * | _getCreator (void) const |
| Get the creator of this object, if any (internal use only) | |
| LightList * | _getLightList () |
| Returns a pointer to the current list of lights for this object. | |
| SceneManager * | _getManager (void) const |
| Get the manager of this object, if any (internal use only) | |
| virtual const Affine3 & | _getParentNodeFullTransform (void) const |
| Return the full transformation of the parent sceneNode or the attachingPoint node. | |
| virtual void | _notifyAttached (Node *parent, bool isTagPoint=false) |
| Internal method called to notify the object that it has been attached to a node. | |
| virtual void | _notifyCreator (MovableObjectFactory *fact) |
| Notify the object of it's creator (internal use only) | |
| virtual void | _notifyManager (SceneManager *man) |
| Notify the object of it's manager (internal use only) | |
| virtual void | _notifyMoved (void) |
| Internal method called to notify the object that it has been moved. | |
| virtual void | _releaseManualHardwareResources () |
| Notifies the movable object that hardware resources were lost. | |
| virtual void | _restoreManualHardwareResources () |
| Notifies the movable object that hardware resources should be restored. | |
| void | addQueryFlags (uint32 flags) |
| As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. | |
| void | addVisibilityFlags (uint32 flags) |
| As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. | |
| void | detachFromParent (void) |
| Detaches an object from a parent SceneNode or TagPoint, if attached. | |
| Real | getBoundingRadiusScaled () const |
| as getBoundingRadius, but with scaling applied | |
| bool | getCastShadows (void) const override |
| Returns whether shadow casting is enabled for this object. | |
| uint32 | getLightMask () const |
| Get a bitwise mask which will filter the lights affecting this object. | |
| Listener * | getListener (void) const |
| Gets the current listener for this object. | |
| const String & | getName (void) const |
| Returns the name of this object. | |
| Node * | getParentNode (void) const |
| Returns the node to which this object is attached. | |
| SceneNode * | getParentSceneNode (void) const |
| Returns the scene node to which this object is attached. | |
| Real | getPointExtrusionDistance (const Light *l) const override |
| Get the distance to extrude for a point/spot light. | |
| virtual uint32 | getQueryFlags (void) const |
| Returns the query flags relevant for this object. | |
| bool | getReceivesShadows () |
| Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. | |
| Real | getRenderingDistance (void) const |
| Gets the distance at which batches are no longer rendered. | |
| Real | getRenderingMinPixelSize () const |
| Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. | |
| uint8 | getRenderQueueGroup (void) const |
| Gets the queue group for this entity. | |
| virtual uint32 | getTypeFlags (void) const |
| Get the 'type flags' for this MovableObject. | |
| const Any & | getUserAny (void) const |
| UserObjectBindings & | getUserObjectBindings () |
| Class that provides convenient interface to establish a linkage between custom user application objects and Ogre core classes. | |
| const UserObjectBindings & | getUserObjectBindings () const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| virtual uint32 | getVisibilityFlags (void) const |
| Returns the visibility flags relevant for this object. | |
| bool | getVisible (void) const |
| Gets this object whether to be visible or not, if it has a renderable component. | |
| const AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const override |
| Retrieves the axis-aligned bounding box for this object in world coordinates. | |
| virtual const Sphere & | getWorldBoundingSphere (bool derive=false) const |
| Retrieves the worldspace bounding sphere for this object. | |
| bool | isAttached (void) const |
| Returns true if this object is attached to a SceneNode or TagPoint. | |
| bool | isDebugDisplayEnabled (void) const |
| Gets whether debug display of this object is enabled. | |
| virtual bool | isInScene (void) const |
| Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. | |
| bool | isParentTagPoint () const |
| Gets whether the parent node is a TagPoint (or a SceneNode) | |
| virtual bool | isVisible (void) const |
| Returns whether or not this object is supposed to be visible or not. | |
| const LightList & | queryLights (void) const |
| Gets a list of lights, ordered relative to how close they are to this movable object. | |
| void | removeQueryFlags (uint32 flags) |
| As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. | |
| void | removeVisibilityFlags (uint32 flags) |
| As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. | |
| void | setCastShadows (bool enabled) |
| Sets whether or not this object will cast shadows. | |
| void | setDebugDisplayEnabled (bool enabled) |
| Sets whether or not the debug display of this object is enabled. | |
| void | setLightMask (uint32 lightMask) |
| Set a bitwise mask which will filter the lights affecting this object. | |
| void | setListener (Listener *listener) |
| Sets a listener for this object. | |
| void | setQueryFlags (uint32 flags) |
| Sets the query flags for this object. | |
| void | setRenderingDistance (Real dist) |
| Sets the distance at which the object is no longer rendered. | |
| void | setRenderingMinPixelSize (Real pixelSize) |
| Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. | |
| virtual void | setRenderQueueGroup (uint8 queueID) |
| Sets the render queue group this entity will be rendered through. | |
| virtual void | setRenderQueueGroupAndPriority (uint8 queueID, ushort priority) |
| Sets the render queue group and group priority this entity will be rendered through. | |
| void | setUserAny (const Any &anything) |
| void | setVisibilityFlags (uint32 flags) |
| Sets the visibility flags for this object. | |
| void | setVisible (bool visible) |
| Tells this object whether to be visible or not, if it has a renderable component. | |
| Public Member Functions inherited from Ogre::ShadowCaster | |
| virtual | ~ShadowCaster () |
| const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const |
| Gets the world space bounding box of the dark cap, as extruded using the light provided. | |
| virtual EdgeData * | getEdgeList (void) |
| Returns details of the edges which might be used to determine a silhouette. | |
| const AxisAlignedBox & | getLightCapBounds (void) const |
| Gets the world space bounding box of the light cap. | |
| virtual const ShadowRenderableList & | getShadowVolumeRenderableList (const Light *light, const HardwareIndexBufferPtr &indexBuffer, size_t &indexBufferUsedSize, float extrusionDistance, int flags=0) |
| Gets an list of the renderables required to render the shadow volume. | |
| bool | hasEdgeList () |
| Returns whether the object has a valid edge list. | |
| Public Member Functions inherited from Ogre::AnimableObject | |
| AnimableObject () | |
| virtual | ~AnimableObject () |
| virtual AnimableValuePtr | createAnimableValue (const String &valueName) |
| Create a reference-counted AnimableValuePtr for the named value. | |
| virtual const StringVector & | getAnimableValueNames (void) const |
| Gets a list of animable value names for this object. | |
This is the same technique the old InstancedGeometry implementation used (with improvements).
Basically it creates a large vertex buffer with many repeating entities, and sends per instance data through shader constants. Because SM 2.0 & 3.0 have up to 256 shader constant registers, this means there can be approx up to 84 instances per batch, assuming they're not skinned But using shader constants for other stuff (i.e. lighting) also affects negatively this number A mesh with skeletally animated 2 bones reduces the number 84 to 42 instances per batch.
The main advantage of this technique is that it's supported on a high variety of hardware (SM 2.0 cards are required) and the same shader can be used for both skeletally animated normal entities and instanced entities without a single change required.
Unlike the old InstancedGeometry implementation, the developer doesn't need to worry about reaching the 84 instances limit, the InstanceManager automatically takes care of splitting and creating new batches. But beware internally, this means less performance improvement. Another improvement is that vertex buffers are shared between batches, which significantly reduces GPU VRAM usage.
1.9.8