OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::GLES2RenderSystem Class Reference

Implementation of GL ES 2.x as a rendering system. More...

#include <OgreGLES2RenderSystem.h>

+ Inheritance diagram for Ogre::GLES2RenderSystem:

Public Member Functions

 GLES2RenderSystem ()
 
virtual ~GLES2RenderSystem ()
 
void _bindVao (GLContext *context, uint32 vao)
 Bind VAO, context should be equal to current context, as VAOs are not shared
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...
 
uint32 _createVao ()
 Create VAO on current context. More...
 
void _destroyDepthBuffer (RenderTarget *pRenderWnd)
 
void _destroyFbo (GLContext *context, uint32 fbo)
 Destroy FBO immediately or defer if it was created on other context. More...
 
void _destroyVao (GLContext *context, uint32 vao)
 Destroy VAO immediately or defer if it was created on other context. More...
 
void _endFrame (void)
 Ends rendering of a frame to the current viewport. More...
 
GLES2StateCacheManager_getStateCacheManager ()
 
void _initialise () override
 Start up the renderer using the settings selected (Or the defaults if none have been selected). More...
 
void _oneTimeContextInitialization ()
 One time initialization for the RenderState of a context. More...
 
void _render (const RenderOperation &op)
 Render something to the active viewport. More...
 
void _setAlphaRejectSettings (CompareFunction func, unsigned char value, bool alphaToCoverage)
 Sets the global alpha rejection approach for future renders. More...
 
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)
 
void _setDepthBufferFunction (CompareFunction func=CMPF_LESS_EQUAL)
 
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)
 
void _setLineWidth (float width)
 Set the line width when drawing as RenderOperation::OT_LINE_LIST/ RenderOperation::OT_LINE_STRIP. More...
 
void _setPolygonMode (PolygonMode level)
 Sets how to rasterise triangles, as points, wireframe or solid polys. More...
 
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 _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)
 
virtual void _setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
 
void _setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter)
 
void _setViewport (Viewport *vp)
 Sets the provided viewport as the active one for future rendering operations. 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 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 &params, uint16 mask)
 Bind Gpu program parameters. 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...
 
GLint convertCompareFunction (CompareFunction func) const
 
GLint convertStencilOp (StencilOperation op, bool invert=false) const
 
HardwareOcclusionQuerycreateHardwareOcclusionQuery (void)
 Create an object for performing hardware occlusion queries. More...
 
virtual MultiRenderTargetcreateMultiRenderTarget (const String &name)
 Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. More...
 
virtual RenderSystemCapabilitiescreateRenderSystemCapabilities () const
 Query the real capabilities of the GPU and driver in the RenderSystem. More...
 
void destroyRenderWindow (const String &name)
 Destroys a render window. More...
 
virtual void endProfileEvent (void)
 Ends the currently active GPU profiling event. More...
 
unsigned int getDisplayMonitorCount () const
 Gets the number of display monitors. More...
 
const StringgetName (void) const
 Returns the name of the rendering system. More...
 
void initialiseContext (RenderWindow *primary)
 
void initialiseFromRenderSystemCapabilities (RenderSystemCapabilities *caps, RenderTarget *primary)
 Initialize the render system from the capabilities. More...
 
virtual void markProfileEvent (const String &eventName)
 Marks an instantaneous event for graphics profilers. More...
 
void notifyOnContextLost ()
 
void resetRenderer (RenderWindow *pRenderWnd)
 
void setColourBlendState (const ColourBlendState &state)
 Sets the global blending factors for combining subsequent renders with the existing frame contents. More...
 
void setScissorTest (bool enabled, const Rect &rect=Rect())
 Sets the 'scissor region' i.e. 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)
 This method allows you to set all the stencil buffer parameters in one call. More...
 
void setStencilCheckEnabled (bool enabled)
 Turns stencil buffer checking on or off. More...
 
void shutdown (void)
 Shutdown the renderer and cleanup resources. More...
 
void unbindGpuProgram (GpuProgramType gptype)
 Unbinds GpuPrograms of a given GpuProgramType. More...
 
- Public Member Functions inherited from Ogre::GLRenderSystemCommon
virtual ~GLRenderSystemCommon ()
 
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...
 
GLContext_getCurrentContext ()
 Returns the current context. More...
 
virtual void _getDepthStencilFormatFor (PixelFormat internalColourFormat, uint32 *depthFormat, uint32 *stencilFormat)
 Mimics D3D9RenderSystem::_getDepthStencilFormatFor, if no FBO RTT manager, outputs GL_NONE. More...
 
GLContext_getMainContext ()
 Returns the main context. More...
 
bool checkExtension (const String &ext) const
 Check if an extension is available. More...
 
Real getHorizontalTexelOffset (void)
 Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. 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...
 
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 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 setConfigOption (const String &name, const String &value)
 Sets an option for this API. More...
 
void unregisterThread ()
 Unregister an additional thread which may make calls to rendersystem-related objects. More...
 
String validateConfigOptions ()
 Validates the options set for the rendering system, returning a message if there are problems. More...
 
- Public Member Functions inherited from Ogre::RenderSystem
 RenderSystem ()
 Default Constructor. More...
 
virtual ~RenderSystem ()
 Destructor. More...
 
virtual void _beginFrame ()
 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...
 
void _cleanupDepthBuffers (bool bCleanManualBuffers=true)
 Removes all depth buffers. More...
 
bool _createRenderWindows (const RenderWindowDescriptionList &renderWindowDescriptions, RenderWindowList &createdWindows)
 
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)
 
virtual unsigned int _getBatchCount (void) const
 Reports the number of batches rendered since the last _beginGeometryCount call. More...
 
virtual CullingMode _getCullingMode (void) const
 
const String_getDefaultViewportMaterialScheme (void) const
 Returns the default material scheme used by the render system. More...
 
virtual unsigned int _getFaceCount (void) const
 Reports the number of tris rendered since the last _beginGeometryCount call. More...
 
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 _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...
 
virtual RenderSystemContext_pauseFrame (void)
 Pause rendering for a frame. More...
 
virtual void _resumeFrame (RenderSystemContext *context)
 Resume rendering for a frame. More...
 
void _setColourBufferWriteEnabled (bool red, bool green, bool blue, bool alpha)
 
void _setFog (FogMode f)
 
virtual void _setPointParameters (bool attenuationEnabled, Real minSize, Real maxSize)
 
virtual 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 _setProjectionMatrix (Matrix4 m)
 
void _setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendOperation op=SBO_ADD)
 
void _setSeparateSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendFactor sourceFactorAlpha, SceneBlendFactor destFactorAlpha, SceneBlendOperation op=SBO_ADD, SceneBlendOperation alphaOp=SBO_ADD)
 
virtual void _setTextureBlendMode (size_t unit, const LayerBlendModeEx &bm)
 Sets the texture blend modes from a TextureUnitState record. More...
 
virtual void _setTextureCoordCalculation (size_t unit, TexCoordCalcMethod m, const Frustum *frustum=0)
 Sets a method for automatically calculating texture coordinates for a stage. More...
 
virtual void _setTextureCoordSet (size_t unit, size_t index)
 Sets the texture coordinate set to use for a texture unit. More...
 
virtual void _setTextureMatrix (size_t unit, 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 _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 _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...
 
virtual void _updateAllRenderTargets (bool swapBuffers=true)
 Internal method for updating all render targets attached to this rendering system. More...
 
virtual 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...
 
virtual void applyFixedFunctionParams (const GpuProgramParametersPtr &params, uint16 variabilityMask)
 
void attachRenderTarget (RenderTarget &target)
 Attaches the passed render target to the render system. More...
 
virtual void bindGpuProgramPassIterationParameters (GpuProgramType gptype)
 
void convertColourValue (const ColourValue &colour, uint32 *pDest)
 
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...
 
virtual RenderTargetdetachRenderTarget (const String &name)
 Detaches the render target with the passed name from the render system and returns a pointer to it. More...
 
const RenderSystemCapabilitiesgetCapabilities (void) const
 Gets the capabilities of the render system. More...
 
virtual VertexElementType getColourVertexElementType (void) const
 
const ConfigOptionMapgetConfigOptions () 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...
 
const DriverVersiongetDriverVersion (void) const
 Returns the driver version. More...
 
virtual const GpuProgramParametersPtrgetFixedFunctionParams (TrackVertexColourType tracking, FogMode fog)
 
HardwareVertexBufferSharedPtr getGlobalInstanceVertexBuffer () const
 Returns the global instance vertex buffer. More...
 
VertexDeclarationgetGlobalInstanceVertexBufferVertexDeclaration () 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...
 
bool getInvertVertexWinding (void) const
 Indicates whether or not the vertex windings set will be inverted for the current render (e.g. More...
 
RenderSystemCapabilitiesgetMutableCapabilities ()
 Get a pointer to the current capabilities being used by the RenderSystem. More...
 
uint16 getNativeShadingLanguageVersion () const
 Gets the native shading language version for this render system. More...
 
const StringVectorgetRenderSystemEvents (void) const
 Gets a list of the rendersystem specific events that this rendersystem can raise. More...
 
RenderTargetgetRenderTarget (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...
 
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...
 
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...
 
virtual void setClipPlanes (const PlaneList &clipPlanes)
 Sets the user clipping region. 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...
 
virtual bool setDrawBuffer (ColourBufferType colourBuffer)
 Sets the colour buffer that the render system will to draw. 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...
 
virtual void setLightingEnabled (bool enabled)
 Sets whether or not dynamic lighting is enabled. More...
 
virtual void setNormaliseNormals (bool normalise)
 Sets whether or not normals are to be automatically normalised. More...
 
void setScissorTest (bool enabled, size_t left, size_t top=0, size_t right=800, size_t bottom=600)
 
virtual void setShadingType (ShadeOptions so)
 Sets the type of light shading required (default = Gouraud). More...
 
void setStencilState (const StencilState &state)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void useCustomRenderSystemCapabilities (RenderSystemCapabilities *capabilities)
 Force the render system to use the special capabilities. More...
 

Static Public Member Functions

static GLES2ManagedResourceManagergetResourceManager ()
 
- Static Public Member Functions inherited from Ogre::RenderSystem
static ListenergetSharedListener (void)
 Retrieve a pointer to the current shared render system listener. More...
 
static void setSharedListener (Listener *listener)
 Sets shared listener. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::GLRenderSystemCommon
typedef std::vector< VideoModeVideoModes
 
- Public Types inherited from Ogre::RenderSystem
typedef MapIterator< Ogre::RenderTargetMapRenderTargetIterator
 Iterator over RenderTargets. More...
 

Detailed Description

Implementation of GL ES 2.x as a rendering system.


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