![]() |
OGRE
1.12.4
Object-Oriented Graphics Rendering Engine
|
Implementation of GL as a rendering system. More...
#include <OgreGLRenderSystem.h>
Public Types | |
typedef MapIterator< Ogre::RenderTargetMap > | RenderTargetIterator |
Iterator over RenderTargets. More... | |
typedef std::vector< VideoMode > | VideoModes |
Public Member Functions | |
GLRenderSystem () | |
~GLRenderSystem () | |
void | _beginFrame (void) |
Signifies the beginning of a frame, i.e. More... | |
virtual void | _beginGeometryCount (void) |
The RenderSystem will keep a count of tris rendered, this resets the count. More... | |
virtual void | _bindVao (GLContext *context, uint32 vao) |
Bind VAO, context should be equal to current context, as VAOs are not shared More... | |
void | _cleanupDepthBuffers (bool bCleanManualBuffers=true) |
Removes all depth buffers. More... | |
void | _completeDeferredVaoFboDestruction () |
Complete destruction of VAOs and FBOs deferred while creator context was not current. More... | |
void | _convertProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest, bool) |
Converts a uniform projection matrix to suitable for this render system. More... | |
void | _copyContentsToMemory (Viewport *vp, const Box &src, const PixelBox &dst, RenderWindow::FrameBuffer buffer) |
Copies the current contents of the render target to a pixelbox. More... | |
DepthBuffer * | _createDepthBufferFor (RenderTarget *renderTarget) |
Creates a DepthBuffer that can be attached to the specified RenderTarget. More... | |
RenderWindow * | _createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0) |
Creates a new rendering window. More... | |
bool | _createRenderWindows (const RenderWindowDescriptionList &renderWindowDescriptions, RenderWindowList &createdWindows) |
Creates multiple rendering windows. More... | |
virtual uint32 | _createVao () |
Create VAO on current context. More... | |
virtual void | _destroyFbo (GLContext *context, uint32 fbo) |
Destroy FBO immediately or defer if it was created on other context. More... | |
virtual void | _destroyVao (GLContext *context, uint32 vao) |
Destroy VAO immediately or defer if it was created on other context. More... | |
virtual void | _disableTextureUnit (size_t texUnit) |
Turns off a texture unit. More... | |
virtual void | _disableTextureUnitsFrom (size_t texUnit) |
Disables all texture units from the given unit upwards. More... | |
virtual void | _dispatchCompute (const Vector3i &workgroupDim) |
void | _endFrame (void) |
Ends rendering of a frame to the current viewport. More... | |
virtual unsigned int | _getBatchCount (void) const |
Reports the number of batches rendered since the last _beginGeometryCount call. More... | |
virtual CullingMode | _getCullingMode (void) const |
GLContext * | _getCurrentContext () |
Returns the current context. More... | |
const String & | _getDefaultViewportMaterialScheme (void) const |
Returns the default material scheme used by the render system. More... | |
virtual void | _getDepthStencilFormatFor (PixelFormat internalColourFormat, uint32 *depthFormat, uint32 *stencilFormat) |
Mimics D3D9RenderSystem::_getDepthStencilFormatFor, if no FBO RTT manager, outputs GL_NONE. More... | |
virtual unsigned int | _getFaceCount (void) const |
Reports the number of tris rendered since the last _beginGeometryCount call. More... | |
GLContext * | _getMainContext () |
Returns the main context. More... | |
GLStateCacheManager * | _getStateCacheManager () |
virtual unsigned int | _getVertexCount (void) const |
Reports the number of vertices passed to the renderer since the last _beginGeometryCount call. More... | |
virtual Viewport * | _getViewport (void) |
Get the current active viewport for rendering. More... | |
void | _initialise () override |
Start up the renderer using the settings selected (Or the defaults if none have been selected). More... | |
void | _initRenderTargets (void) |
Utility method for initialising all render targets attached to this rendering system. More... | |
void | _notifyCameraRemoved (const Camera *cam) |
Utility method to notify all render targets that a camera has been removed, in case they were referring to it as their viewer. More... | |
void | _oneTimeContextInitialization () |
One time initialization for the RenderState of a context. More... | |
virtual RenderSystemContext * | _pauseFrame (void) |
Pause rendering for a frame. More... | |
void | _render (const RenderOperation &op) |
Render something to the active viewport. More... | |
virtual void | _resumeFrame (RenderSystemContext *context) |
Resume rendering for a frame. More... | |
void | _setAlphaRejectSettings (CompareFunction func, unsigned char value, bool alphaToCoverage) |
Sets the global alpha rejection approach for future renders. More... | |
void | _setColourBufferWriteEnabled (bool red, bool green, bool blue, bool alpha) |
void | _setCullingMode (CullingMode mode) |
Sets the culling mode for the render system based on the 'vertex winding'. More... | |
void | _setDepthBias (float constantBias, float slopeScaleBias) |
Sets the depth bias, NB you should use the Material version of this. More... | |
void | _setDepthBufferCheckEnabled (bool enabled=true) |
Sets whether or not the depth buffer check is performed before a pixel write. More... | |
void | _setDepthBufferFunction (CompareFunction func=CMPF_LESS_EQUAL) |
Sets the comparison function for the depth buffer check. More... | |
void | _setDepthBufferParams (bool depthTest=true, bool depthWrite=true, CompareFunction depthFunction=CMPF_LESS_EQUAL) |
Sets the mode of operation for depth buffer tests from this point onwards. More... | |
void | _setDepthBufferWriteEnabled (bool enabled=true) |
Sets whether or not the depth buffer is updated after a pixel write. More... | |
void | _setFog (FogMode mode) |
void | _setLineWidth (float width) |
Set the line width when drawing as RenderOperation::OT_LINE_LIST/ RenderOperation::OT_LINE_STRIP. More... | |
void | _setPointParameters (bool attenuationEnabled, Real minSize, Real maxSize) |
void | _setPointSpritesEnabled (bool enabled) |
Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points. More... | |
void | _setPolygonMode (PolygonMode level) |
Sets how to rasterise triangles, as points, wireframe or solid polys. More... | |
void | _setProjectionMatrix (Matrix4 m) |
void | _setRenderTarget (RenderTarget *target) |
Set current render target to target, enabling its GL context if needed. More... | |
void | _setSampler (size_t unit, Sampler &sampler) |
set the sampler settings for the given texture unit More... | |
void | _setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendOperation op=SBO_ADD) |
void | _setSeparateSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendFactor sourceFactorAlpha, SceneBlendFactor destFactorAlpha, SceneBlendOperation op, SceneBlendOperation alphaOp) |
void | _setSurfaceTracking (TrackVertexColourType tracking) |
void | _setTexture (size_t unit, bool enabled, const TexturePtr &tex) |
Sets the texture to bind to a given texture unit. More... | |
void | _setTextureAddressingMode (size_t stage, const Sampler::UVWAddressingMode &uvw) |
void | _setTextureBlendMode (size_t stage, const LayerBlendModeEx &bm) |
Sets the texture blend modes from a TextureUnitState record. More... | |
void | _setTextureCoordCalculation (size_t stage, TexCoordCalcMethod m, const Frustum *frustum=0) |
Sets a method for automatically calculating texture coordinates for a stage. More... | |
void | _setTextureCoordSet (size_t stage, size_t index) |
Sets the texture coordinate set to use for a texture unit. More... | |
void | _setTextureMatrix (size_t stage, const Matrix4 &xform) |
Sets the texture coordinate transformation matrix for a texture unit. More... | |
virtual void | _setTextureProjectionRelativeTo (bool enabled, const Vector3 &pos) |
Notify the rendersystem that it should adjust texture projection to be relative to a different origin. More... | |
virtual void | _setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter) |
void | _setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter) |
virtual void | _setTextureUnitSettings (size_t texUnit, TextureUnitState &tl) |
Utility function for setting all the properties of a texture unit at once. More... | |
virtual void | _setVertexTexture (size_t unit, const TexturePtr &tex) |
Binds a texture to a vertex, geometry, compute, tesselation hull or tessellation domain sampler. More... | |
void | _setViewMatrix (const Matrix4 &m) |
void | _setViewport (Viewport *vp) |
Sets the provided viewport as the active one for future rendering operations. More... | |
void | _setWorldMatrix (const Matrix4 &m) |
virtual void | _swapAllRenderTargetBuffers () |
Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was called with a 'false' parameter. More... | |
void | _switchContext (GLContext *context) |
Switch GL context, dealing with involved internal cached states too. More... | |
void | _unregisterContext (GLContext *context) |
Unregister a render target->context mapping. More... | |
virtual void | _updateAllRenderTargets (bool swapBuffers=true) |
Internal method for updating all render targets attached to this rendering system. More... | |
void | _useLights (unsigned short limit) |
Tells the rendersystem to use the attached set of lights (and no others) up to the number specified (this allows the same list to be used with different count limits) More... | |
void | addListener (Listener *l) |
Adds a listener to the custom events that this render system can raise. More... | |
void | applyFixedFunctionParams (const GpuProgramParametersPtr ¶ms, uint16 variabilityMask) |
void | attachRenderTarget (RenderTarget &target) |
Attaches the passed render target to the render system. More... | |
virtual void | beginProfileEvent (const String &eventName) |
This marks the beginning of an event for GPU profiling. More... | |
void | bindGpuProgram (GpuProgram *prg) |
Binds a given GpuProgram (but not the parameters). More... | |
void | bindGpuProgramParameters (GpuProgramType gptype, const GpuProgramParametersPtr ¶ms, uint16 variabilityMask) |
Bind Gpu program parameters. More... | |
virtual void | bindGpuProgramPassIterationParameters (GpuProgramType gptype) |
bool | checkExtension (const String &ext) const |
Check if an extension is available. More... | |
void | clearFrameBuffer (unsigned int buffers, const ColourValue &colour=ColourValue::Black, Real depth=1.0f, unsigned short stencil=0) |
Clears one or more frame buffers on the active render target. More... | |
void | convertColourValue (const ColourValue &colour, uint32 *pDest) |
Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem. More... | |
HardwareOcclusionQuery * | createHardwareOcclusionQuery (void) |
Create an object for performing hardware occlusion queries. More... | |
virtual MultiRenderTarget * | createMultiRenderTarget (const String &name) |
Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. More... | |
virtual RenderSystemCapabilities * | createRenderSystemCapabilities () const |
Query the real capabilities of the GPU and driver in the RenderSystem. More... | |
virtual void | destroyHardwareOcclusionQuery (HardwareOcclusionQuery *hq) |
Destroy a hardware occlusion query object. More... | |
virtual void | destroyRenderTarget (const String &name) |
Destroys a render target of any sort. More... | |
virtual void | destroyRenderTexture (const String &name) |
Destroys a render texture. More... | |
void | destroyRenderWindow (const String &name) |
Destroys a render window. More... | |
virtual RenderTarget * | detachRenderTarget (const String &name) |
Detaches the render target with the passed name from the render system and returns a pointer to it. More... | |
void | enableClipPlane (ushort index, bool enable) |
virtual void | endProfileEvent (void) |
Ends the currently active GPU profiling event. More... | |
const RenderSystemCapabilities * | getCapabilities (void) const |
Gets the capabilities of the render system. More... | |
VertexElementType | getColourVertexElementType (void) const |
Get the native VertexElementType for a compact 32-bit colour value for this rendersystem. More... | |
const ConfigOptionMap & | getConfigOptions () const |
Returns the details of this API's configuration options. More... | |
virtual void | getCustomAttribute (const String &name, void *pData) |
Gets a custom (maybe platform-specific) attribute. More... | |
unsigned int | getDisplayMonitorCount () const |
Gets the number of display monitors. More... | |
const DriverVersion & | getDriverVersion (void) const |
Returns the driver version. More... | |
const GpuProgramParametersPtr & | getFixedFunctionParams (TrackVertexColourType tracking, FogMode fog) |
HardwareVertexBufferSharedPtr | getGlobalInstanceVertexBuffer () const |
Returns the global instance vertex buffer. More... | |
VertexDeclaration * | getGlobalInstanceVertexBufferVertexDeclaration () const |
Gets vertex declaration for the global vertex buffer for the global instancing. More... | |
size_t | getGlobalNumberOfInstances () const |
Gets the global number of instances. More... | |
Real | getHorizontalTexelOffset (void) |
Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. More... | |
bool | getInvertVertexWinding (void) const |
Indicates whether or not the vertex windings set will be inverted for the current render (e.g. More... | |
Real | getMaximumDepthInputValue (void) |
Gets the maximum (farthest) depth value to be used when rendering using identity transforms. More... | |
Real | getMinimumDepthInputValue (void) |
Gets the minimum (closest) depth value to be used when rendering using identity transforms. More... | |
RenderSystemCapabilities * | getMutableCapabilities () |
Get a pointer to the current capabilities being used by the RenderSystem. More... | |
const String & | getName (void) const |
Returns the name of the rendering system. More... | |
uint16 | getNativeShadingLanguageVersion () const |
Gets the native shading language version for this render system. More... | |
const StringVector & | getRenderSystemEvents (void) const |
Gets a list of the rendersystem specific events that this rendersystem can raise. More... | |
RenderTarget * | getRenderTarget (const String &name) |
Returns a pointer to the render target with the passed name, or NULL if that render target cannot be found. More... | |
RenderTargetIterator | getRenderTargetIterator (void) |
Returns a specialised MapIterator over all render targets attached to the RenderSystem. More... | |
RenderWindowDescription | getRenderWindowDescription () const |
get a RenderWindowDescription from the current ConfigOptionMap More... | |
Real | getVerticalTexelOffset (void) |
Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem. More... | |
bool | hasMinGLVersion (int major, int minor) const |
Check if GL Version is supported. More... | |
void | initialiseFromRenderSystemCapabilities (RenderSystemCapabilities *caps, RenderTarget *primary) |
Initialize the render system from the capabilities. More... | |
bool | isGpuProgramBound (GpuProgramType gptype) |
Returns whether or not a Gpu program of the given type is currently bound. More... | |
bool | isReverseDepthBufferEnabled () const |
Returns if reverse Z-buffer is enabled. More... | |
virtual bool | isStaticBufferLockable () const |
Returns whether under the current render system buffers marked as TU_STATIC can be locked for update. More... | |
virtual void | markProfileEvent (const String &eventName) |
Marks an instantaneous event for graphics profilers. More... | |
void | postExtraThreadsStarted () |
Tell the rendersystem to perform any tasks it needs to directly after other threads which might access the rendering API are registered. More... | |
void | preExtraThreadsStarted () |
Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered. More... | |
void | registerThread () |
Register the an additional thread which may make calls to rendersystem-related objects. More... | |
void | reinitialise (void) |
Restart the renderer (normally following a change in settings). More... | |
void | removeListener (Listener *l) |
Remove a listener to the custom events that this render system can raise. More... | |
void | setClipPlane (ushort index, Real A, Real B, Real C, Real D) |
virtual void | setClipPlanes (const PlaneList &clipPlanes) |
Sets the user clipping region. More... | |
virtual void | setColourBlendState (const ColourBlendState &state) |
Sets the global blending factors for combining subsequent renders with the existing frame contents. More... | |
void | setConfigOption (const String &name, const String &value) |
Sets an option for this API. More... | |
virtual void | setCurrentPassIterationCount (const size_t count) |
set the current multi pass count value. More... | |
void | setDepthBufferFor (RenderTarget *renderTarget) |
Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it. More... | |
void | setDeriveDepthBias (bool derive, float baseValue=0.0f, float multiplier=0.0f, float slopeScale=0.0f) |
Tell the render system whether to derive a depth bias on its own based on the values passed to it in setCurrentPassIterationCount. More... | |
void | setGlobalInstanceVertexBuffer (const HardwareVertexBufferSharedPtr &val) |
Sets the global instance vertex buffer. More... | |
void | setGlobalInstanceVertexBufferVertexDeclaration (VertexDeclaration *val) |
Sets vertex declaration for the global vertex buffer for the global instancing. More... | |
void | setGlobalNumberOfInstances (const size_t val) |
Sets the global number of instances. More... | |
void | setInvertVertexWinding (bool invert) |
Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections. More... | |
void | setLightingEnabled (bool enabled) |
Sets whether or not dynamic lighting is enabled. More... | |
void | setNormaliseNormals (bool normalise) |
Sets whether or not normals are to be automatically normalised. More... | |
void | setProjectionMatrix (const Matrix4 &m) |
void | setScissorTest (bool enabled, size_t left=0, size_t top=0, size_t right=800, size_t bottom=600) |
Sets the 'scissor region' i.e. More... | |
void | setShadingType (ShadeOptions so) |
Sets the type of light shading required (default = Gouraud). More... | |
void | setStencilBufferParams (CompareFunction func=CMPF_ALWAYS_PASS, uint32 refValue=0, uint32 compareMask=0xFFFFFFFF, uint32 writeMask=0xFFFFFFFF, StencilOperation stencilFailOp=SOP_KEEP, StencilOperation depthFailOp=SOP_KEEP, StencilOperation passOp=SOP_KEEP, bool twoSidedOperation=false, bool readBackAsTexture=false) |
See RenderSystem. More... | |
void | setStencilCheckEnabled (bool enabled) |
Turns stencil buffer checking on or off. More... | |
void | setViewMatrix (const Matrix4 &m) |
void | setWorldMatrix (const Matrix4 &m) |
void | shutdown (void) |
Shutdown the renderer and cleanup resources. More... | |
void | unbindGpuProgram (GpuProgramType gptype) |
Unbinds GpuPrograms of a given GpuProgramType. More... | |
void | unregisterThread () |
Unregister an additional thread which may make calls to rendersystem-related objects. More... | |
void | useCustomRenderSystemCapabilities (RenderSystemCapabilities *capabilities) |
Force the render system to use the special capabilities. More... | |
String | validateConfigOptions () |
Validates the options set for the rendering system, returning a message if there are problems. More... | |
Static Public Member Functions | |
static Listener * | getSharedListener (void) |
Retrieve a pointer to the current shared render system listener. More... | |
static void | setSharedListener (Listener *listener) |
Sets shared listener. More... | |
Implementation of GL as a rendering system.
|
inherited |
|
inherited |
Iterator over RenderTargets.
Ogre::GLRenderSystem::GLRenderSystem | ( | ) |
Ogre::GLRenderSystem::~GLRenderSystem | ( | ) |
|
virtual |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Returns the name of the rendering system.
Implements Ogre::RenderSystem.
|
overridevirtual |
Start up the renderer using the settings selected (Or the defaults if none have been selected).
Called by Root::setRenderSystem. Shouldn't really be called directly, although this can be done if the app wants to.
Reimplemented from Ogre::RenderSystem.
|
virtual |
Query the real capabilities of the GPU and driver in the RenderSystem.
Implements Ogre::RenderSystem.
|
virtual |
Initialize the render system from the capabilities.
Implements Ogre::RenderSystem.
|
virtual |
Shutdown the renderer and cleanup resources.
Reimplemented from Ogre::RenderSystem.
|
virtual |
Sets the type of light shading required (default = Gouraud).
Reimplemented from Ogre::RenderSystem.
|
virtual |
Sets whether or not dynamic lighting is enabled.
enabled | If true, dynamic lighting is performed on geometry with normals supplied, geometry without normals will not be displayed. If false, no lighting is applied and all geometry will be full brightness. |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Creates a new rendering window.
name | The name of the window. Used in other methods later like setRenderTarget and getRenderTarget. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
width | The width of the new window. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
height | The height of the new window. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fullScreen | Specify true to make the window full screen without borders, title bar or menu bar. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
miscParams | A NameValuePairList describing the other parameters for the new rendering window. Options are case sensitive. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platforms unless indicated otherwise:
|
Implements Ogre::RenderSystem.
|
virtual |
Creates multiple rendering windows.
renderWindowDescriptions | Array of structures containing the descriptions of each render window. The structure's members are the same as the parameters of _createRenderWindow: name width height fullScreen miscParams See _createRenderWindow for details about each member. |
createdWindows | This array will hold the created render windows. |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Creates a DepthBuffer that can be attached to the specified RenderTarget.
Implements Ogre::RenderSystem.
|
virtual |
Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once.
Surfaces can be bound and unbound at will. This fails if mCapabilities->getNumMultiRenderTargets() is smaller than 2.
Implements Ogre::RenderSystem.
|
virtual |
Destroys a render window.
Reimplemented from Ogre::RenderSystem.
|
virtual |
Sets whether or not normals are to be automatically normalised.
Reimplemented from Ogre::RenderSystem.
|
virtual |
Tells the rendersystem to use the attached set of lights (and no others) up to the number specified (this allows the same list to be used with different count limits)
Reimplemented from Ogre::RenderSystem.
void Ogre::GLRenderSystem::setWorldMatrix | ( | const Matrix4 & | m | ) |
void Ogre::GLRenderSystem::setViewMatrix | ( | const Matrix4 & | m | ) |
void Ogre::GLRenderSystem::setProjectionMatrix | ( | const Matrix4 & | m | ) |
void Ogre::GLRenderSystem::_setSurfaceTracking | ( | TrackVertexColourType | tracking | ) |
|
virtual |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Set the line width when drawing as RenderOperation::OT_LINE_LIST/ RenderOperation::OT_LINE_STRIP.
width | only value of 1.0 might be supported. Check for RSC_WIDE_LINES. |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points.
enabled | True enables point sprites, false returns to normal point rendering. |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Sets the texture to bind to a given texture unit.
User processes would not normally call this direct unless rendering primitives themselves.
unit | The index of the texture unit to modify. Multitexturing hardware can support multiple units (see RenderSystemCapabilites::getNumTextureUnits) |
enabled | Boolean to turn the unit on/off |
texPtr | Pointer to the texture to use. |
Implements Ogre::RenderSystem.
|
virtual |
set the sampler settings for the given texture unit
Implements Ogre::RenderSystem.
|
virtual |
Sets the texture coordinate set to use for a texture unit.
Meant for use internally - not generally used directly by apps - the Material and TextureUnitState classes let you manage textures far more easily.
unit | Texture unit as above |
index | The index of the texture coordinate set to use. |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Sets a method for automatically calculating texture coordinates for a stage.
Should not be used by apps - for use by Ogre only.
unit | Texture unit as above |
m | Calculation method to use |
frustum | Optional Frustum param, only used for projective effects |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Sets the texture blend modes from a TextureUnitState record.
Meant for use internally only - apps should use the Material and TextureUnitState classes.
unit | Texture unit as above |
bm | Details of the blending mode |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Implements Ogre::RenderSystem.
|
virtual |
Sets the texture coordinate transformation matrix for a texture unit.
unit | Texture unit to affect |
xform | The 4x4 matrix |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Implements Ogre::RenderSystem.
|
virtual |
Sets the global alpha rejection approach for future renders.
By default images are rendered regardless of texture alpha. This method lets you change that.
func | The comparison function which must pass for a pixel to be written. |
value | The value to compare each pixels alpha value to (0-255) |
alphaToCoverage | Whether to enable alpha to coverage, if supported |
Implements Ogre::RenderSystem.
|
virtual |
Sets the provided viewport as the active one for future rendering operations.
This viewport is aware of it's own camera and render target. Must be implemented by subclass.
vp | Pointer to the appropriate viewport. |
Implements Ogre::RenderSystem.
|
virtual |
Signifies the beginning of a frame, i.e.
the start of rendering on a single viewport. Will occur several times per complete frame if multiple viewports exist.
Implements Ogre::RenderSystem.
|
virtual |
Ends rendering of a frame to the current viewport.
Implements Ogre::RenderSystem.
|
virtual |
Sets the culling mode for the render system based on the 'vertex winding'.
A typical way for the rendering engine to cull triangles is based on the 'vertex winding' of triangles. Vertex winding refers to the direction in which the vertices are passed or indexed to in the rendering operation as viewed from the camera, and will wither be clockwise or anticlockwise (that's 'counterclockwise' for you Americans out there ;) The default is CULL_CLOCKWISE i.e. that only triangles whose vertices are passed/indexed in anticlockwise order are rendered - this is a common approach and is used in 3D studio models for example. You can alter this culling mode if you wish but it is not advised unless you know what you are doing. You may wish to use the CULL_NONE option for mesh data that you cull yourself where the vertex winding is uncertain.
Implements Ogre::RenderSystem.
|
virtual |
Sets the mode of operation for depth buffer tests from this point onwards.
Sometimes you may wish to alter the behaviour of the depth buffer to achieve special effects. Because it's unlikely that you'll set these options for an entire frame, but rather use them to tweak settings between rendering objects, this is an internal method (indicated by the '_' prefix) which will be used by a SceneManager implementation rather than directly from the client application. If this method is never called the settings are automatically the same as the default parameters.
depthTest | If true, the depth buffer is tested for each pixel and the frame buffer is only updated if the depth function test succeeds. If false, no test is performed and pixels are always written. |
depthWrite | If true, the depth buffer is updated with the depth of the new pixel if the depth test succeeds. If false, the depth buffer is left unchanged even if a new pixel is written. |
depthFunction | Sets the function required for the depth test. |
Implements Ogre::RenderSystem.
|
virtual |
Sets whether or not the depth buffer check is performed before a pixel write.
enabled | If true, the depth buffer is tested for each pixel and the frame buffer is only updated if the depth function test succeeds. If false, no test is performed and pixels are always written. |
Implements Ogre::RenderSystem.
|
virtual |
Sets whether or not the depth buffer is updated after a pixel write.
enabled | If true, the depth buffer is updated with the depth of the new pixel if the depth test succeeds. If false, the depth buffer is left unchanged even if a new pixel is written. |
Implements Ogre::RenderSystem.
|
virtual |
Sets the comparison function for the depth buffer check.
Advanced use only - allows you to choose the function applied to compare the depth values of new and existing pixels in the depth buffer. Only an issue if the deoth buffer check is enabled (see _setDepthBufferCheckEnabled)
func | The comparison between the new depth and the existing depth which must return true for the new pixel to be written. |
Implements Ogre::RenderSystem.
|
virtual |
Sets the depth bias, NB you should use the Material version of this.
constantBias | The constant bias value, expressed as a value in homogeneous depth coordinates. |
slopeScaleBias | The bias value which is factored by the maximum slope of the polygon, see the description above. This is not supported by all cards. |
Implements Ogre::RenderSystem.
|
virtual |
Implements Ogre::RenderSystem.
void Ogre::GLRenderSystem::_setFog | ( | FogMode | mode | ) |
void Ogre::GLRenderSystem::enableClipPlane | ( | ushort | index, |
bool | enable | ||
) |
|
virtual |
Sets how to rasterise triangles, as points, wireframe or solid polys.
Implements Ogre::RenderSystem.
|
virtual |
Turns stencil buffer checking on or off.
Implements Ogre::RenderSystem.
|
virtual |
See RenderSystem.
Implements Ogre::RenderSystem.
|
virtual |
Implements Ogre::RenderSystem.
|
virtual |
Render something to the active viewport.
Low-level rendering interface to perform rendering operations. Unlikely to be used directly by client applications, since the SceneManager and various support classes will be responsible for calling this method. Can only be called between _beginScene and _endScene
op | A rendering operation instance, which contains details of the operation to be performed. |
Reimplemented from Ogre::RenderSystem.
|
virtual |
Binds a given GpuProgram (but not the parameters).
Reimplemented from Ogre::RenderSystem.
|
virtual |
Unbinds GpuPrograms of a given GpuProgramType.
Reimplemented from Ogre::RenderSystem.
|
virtual |
Bind Gpu program parameters.
gptype | The type of program to bind the parameters to |
params | The parameters to bind |
variabilityMask | A mask of GpuParamVariability identifying which params need binding |
Implements Ogre::RenderSystem.
|
virtual |
Sets the 'scissor region' i.e.
the region of the target in which rendering can take place.
enabled | True to enable the scissor test, false to disable it. |
left,top,right,bottom | The location of the corners of the rectangle, expressed in pixels. |
Implements Ogre::RenderSystem.
|
virtual |
Clears one or more frame buffers on the active render target.
buffers | Combination of one or more elements of FrameBufferType denoting which buffers are to be cleared |
colour | The colour to clear the colour buffer with, if enabled |
depth | The value to initialise the depth buffer with, if enabled |
stencil | The value to initialise the stencil buffer with, if enabled. |
Implements Ogre::RenderSystem.
|
virtual |
Create an object for performing hardware occlusion queries.
Implements Ogre::RenderSystem.
|
virtual |
One time initialization for the RenderState of a context.
Things that only need to be set once, like the LightingModel can be defined here.
Implements Ogre::GLRenderSystemCommon.
void Ogre::GLRenderSystem::_switchContext | ( | GLContext * | context | ) |
Switch GL context, dealing with involved internal cached states too.
|
virtual |
Set current render target to target, enabling its GL context if needed.
Implements Ogre::RenderSystem.
|
virtual |
Unregister a render target->context mapping.
If the context of target is the current context, change the context to the main context so it can be destroyed safely.
Implements Ogre::GLRenderSystemCommon.
|
inline |
|
virtual |
Gets the number of display monitors.
Implements Ogre::RenderSystem.
|
virtual |
This marks the beginning of an event for GPU profiling.
Implements Ogre::RenderSystem.
|
virtual |
Ends the currently active GPU profiling event.
Implements Ogre::RenderSystem.
|
virtual |
Marks an instantaneous event for graphics profilers.
This is equivalent to calling
Implements Ogre::RenderSystem.
|
virtual |
Copies the current contents of the render target to a pixelbox.
Implements Ogre::GLRenderSystemCommon.
|
virtualinherited |
Sets an option for this API.
name | The name of the option to alter. |
value | The value to set the option to. |
Implements Ogre::RenderSystem.
|
inlineinherited |
Returns the main context.
|
inlineinherited |
Returns the current context.
|
inherited |
Check if GL Version is supported.
|
inherited |
Check if an extension is available.
|
inlinevirtualinherited |
Validates the options set for the rendering system, returning a message if there are problems.
Implements Ogre::RenderSystem.
References Ogre::BLANKSTRING.
|
inlinevirtualinherited |
Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Implements Ogre::RenderSystem.
|
inlinevirtualinherited |
Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Implements Ogre::RenderSystem.
|
inlinevirtualinherited |
Gets the minimum (closest) depth value to be used when rendering using identity transforms.
Implements Ogre::RenderSystem.
|
inlinevirtualinherited |
Gets the maximum (farthest) depth value to be used when rendering using identity transforms.
Implements Ogre::RenderSystem.
|
inlinevirtualinherited |
Get the native VertexElementType for a compact 32-bit colour value for this rendersystem.
Implements Ogre::RenderSystem.
References Ogre::VET_COLOUR_ABGR.
|
inlinevirtualinherited |
Restart the renderer (normally following a change in settings).
Implements Ogre::RenderSystem.
|
virtualinherited |
Converts a uniform projection matrix to suitable for this render system.
Implements Ogre::RenderSystem.
|
virtualinherited |
Mimics D3D9RenderSystem::_getDepthStencilFormatFor, if no FBO RTT manager, outputs GL_NONE.
Reimplemented in Ogre::GL3PlusRenderSystem.
|
inlinevirtualinherited |
Create VAO on current context.
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtualinherited |
Bind VAO, context should be equal to current context, as VAOs are not shared
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtualinherited |
Destroy VAO immediately or defer if it was created on other context.
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtualinherited |
Destroy FBO immediately or defer if it was created on other context.
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inherited |
Complete destruction of VAOs and FBOs deferred while creator context was not current.
|
virtualinherited |
Register the an additional thread which may make calls to rendersystem-related objects.
Implements Ogre::RenderSystem.
|
virtualinherited |
Unregister an additional thread which may make calls to rendersystem-related objects.
Implements Ogre::RenderSystem.
|
virtualinherited |
Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered.
Implements Ogre::RenderSystem.
|
virtualinherited |
Tell the rendersystem to perform any tasks it needs to directly after other threads which might access the rendering API are registered.
Implements Ogre::RenderSystem.
|
inlineinherited |
Returns the details of this API's configuration options.
|
inherited |
get a RenderWindowDescription from the current ConfigOptionMap
|
virtualinherited |
Destroy a hardware occlusion query object.
|
inlinevirtualinherited |
Returns whether under the current render system buffers marked as TU_STATIC can be locked for update.
Reimplemented in Ogre::D3D9RenderSystem.
|
inlineinherited |
Get a pointer to the current capabilities being used by the RenderSystem.
|
inherited |
Force the render system to use the special capabilities.
Can only be called before the render system has been fully initializer (before createWindow is called)
capabilities | has to be a subset of the real capabilities and the caller is responsible for deallocating capabilities. |
|
inherited |
|
inlineinherited |
References Ogre::GPV_GLOBAL.
|
inlineinherited |
References Ogre::GPV_PER_OBJECT.
|
inlineinherited |
|
virtualinherited |
Destroys a render texture.
|
virtualinherited |
Destroys a render target of any sort.
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::D3D11RenderSystem.
|
inherited |
Attaches the passed render target to the render system.
|
inherited |
Returns a pointer to the render target with the passed name, or NULL if that render target cannot be found.
|
virtualinherited |
Detaches the render target with the passed name from the render system and returns a pointer to it.
Reimplemented in Ogre::D3D9RenderSystem, and Ogre::D3D11RenderSystem.
|
inlineinherited |
Returns a specialised MapIterator over all render targets attached to the RenderSystem.
|
inherited |
Returns the global instance vertex buffer.
|
inherited |
Sets the global instance vertex buffer.
|
inherited |
Gets vertex declaration for the global vertex buffer for the global instancing.
|
inherited |
Sets vertex declaration for the global vertex buffer for the global instancing.
|
inherited |
Gets the global number of instances.
|
inherited |
Sets the global number of instances.
|
inherited |
Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it.
|
inherited |
Returns if reverse Z-buffer is enabled.
If you have large scenes and need big far clip distance but still want to draw objects closer (for example cockpit of a plane) you can enable reverse depth buffer so that the depth buffer precision is greater further away. This enables the OGRE_REVERSED_Z preprocessor define for shaders.
true | If reverse Z-buffer is enabled. |
false | If reverse Z-buffer is disabled (default). |
|
virtualinherited |
Utility function for setting all the properties of a texture unit at once.
This method is also worth using over the individual texture unit settings because it only sets those settings which are different from the current settings for this unit, thus minimising render state changes.
|
virtualinherited |
Turns off a texture unit.
Reimplemented in Ogre::D3D9RenderSystem.
|
virtualinherited |
Disables all texture units from the given unit upwards.
|
virtualinherited |
Binds a texture to a vertex, geometry, compute, tesselation hull or tessellation domain sampler.
Reimplemented in Ogre::D3D9RenderSystem.
|
virtualinherited |
Reimplemented in Ogre::GLES2RenderSystem.
|
inlinevirtualinherited |
Sets the global blending factors for combining subsequent renders with the existing frame contents.
References Ogre::ColourBlendState::alphaOperation, Ogre::ColourBlendState::destFactor, Ogre::ColourBlendState::destFactorAlpha, Ogre::ColourBlendState::operation, Ogre::ColourBlendState::sourceFactor, Ogre::ColourBlendState::sourceFactorAlpha, Ogre::ColourBlendState::writeA, Ogre::ColourBlendState::writeB, Ogre::ColourBlendState::writeG, and Ogre::ColourBlendState::writeR.
|
virtualinherited |
Notify the rendersystem that it should adjust texture projection to be relative to a different origin.
|
inherited |
Removes all depth buffers.
Should be called on device lost and shutdown
|
virtualinherited |
Pause rendering for a frame.
This has to be called after _beginFrame and before _endFrame. Will usually be called by the SceneManager, don't use this manually unless you know what you are doing.
Reimplemented in Ogre::D3D9RenderSystem.
|
virtualinherited |
Resume rendering for a frame.
This has to be called after a _pauseFrame call Will usually be called by the SceneManager, don't use this manually unless you know what you are doing.
context | the render system context, as returned by _pauseFrame |
Reimplemented in Ogre::D3D9RenderSystem.
|
virtualinherited |
Get the current active viewport for rendering.
|
virtualinherited |
|
virtualinherited |
The RenderSystem will keep a count of tris rendered, this resets the count.
|
virtualinherited |
Reports the number of tris rendered since the last _beginGeometryCount call.
|
virtualinherited |
Reports the number of batches rendered since the last _beginGeometryCount call.
|
virtualinherited |
Reports the number of vertices passed to the renderer since the last _beginGeometryCount call.
|
inherited |
Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem.
colour | The colour to convert |
pDest | Pointer to location to put the result. |
|
inlinevirtualinherited |
Reimplemented in Ogre::D3D11RenderSystem, and Ogre::GL3PlusRenderSystem.
|
inlineinherited |
Gets the capabilities of the render system.
|
inlineinherited |
Returns the driver version.
|
inherited |
Returns the default material scheme used by the render system.
Systems that use the RTSS to emulate a fixed function pipeline (e.g. OpenGL ES 2, GL3+, DX11) need to return the default material scheme of the RTSS ShaderGenerator.
This is currently only used to set the default material scheme for viewports. It is a necessary step on these render systems for render textures to be rendered into properly.
|
inlinevirtualinherited |
|
inherited |
Returns whether or not a Gpu program of the given type is currently bound.
|
inlineinherited |
Gets the native shading language version for this render system.
Formatted so that it can be used within a shading program. For example, OpenGL 3.2 would return 150, while 3.3 would return 330
|
virtualinherited |
Sets the user clipping region.
|
inherited |
Utility method for initialising all render targets attached to this rendering system.
|
inherited |
Utility method to notify all render targets that a camera has been removed, in case they were referring to it as their viewer.
|
virtualinherited |
Internal method for updating all render targets attached to this rendering system.
Reimplemented in Ogre::D3D11RenderSystem.
|
virtualinherited |
Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was called with a 'false' parameter.
Reimplemented in Ogre::D3D11RenderSystem.
|
inherited |
Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections.
|
inherited |
Indicates whether or not the vertex windings set will be inverted for the current render (e.g.
reflections)
|
inlinevirtualinherited |
set the current multi pass count value.
This must be set prior to calling _render() if multiple renderings of the same pass state are required.
count | Number of times to render the current state. |
|
inlineinherited |
Tell the render system whether to derive a depth bias on its own based on the values passed to it in setCurrentPassIterationCount.
The depth bias set will be baseValue + iteration * multiplier
derive | True to tell the RS to derive this automatically |
baseValue | The base value to which the multiplier should be added |
multiplier | The amount of depth bias to apply per iteration |
slopeScale | The constant slope scale bias for completeness |
|
staticinherited |
Sets shared listener.
|
staticinherited |
Retrieve a pointer to the current shared render system listener.
|
inherited |
Adds a listener to the custom events that this render system can raise.
|
inherited |
Remove a listener to the custom events that this render system can raise.
|
inlineinherited |
Gets a list of the rendersystem specific events that this rendersystem can raise.
|
virtualinherited |
Gets a custom (maybe platform-specific) attribute.
name | The name of the attribute. |
pData | Pointer to memory of the right kind of structure to receive the info. |
Reimplemented in Ogre::D3D11RenderSystem.