OGRE-Next  4.0.0unstable
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 _applyObliqueDepthProjection (Matrix4 &matrix, const Plane &plane, bool forGpuProgram)
 See RenderSystem. More...
 
void _beginFrame ()
 See RenderSystem. More...
 
virtual void _bindTextureUavCS (uint32 slot, Texture *texture, ResourceAccess::ResourceAccess access, int32 mipmapLevel, int32 textureArrayIndex, PixelFormat pixelFormat)
 
DepthBuffer_createDepthBufferFor (RenderTarget *renderTarget, bool exactMatchFormat)
 
RenderWindow * _createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
 Creates a new rendering window. More...
 
void _destroyDepthBuffer (RenderWindow *pRenderWnd)
 
virtual void _dispatch (const HlmsComputePso &pso)
 
void _endFrame ()
 See RenderSystem. More...
 
void _getDepthStencilFormatFor (GLenum internalColourFormat, GLenum *depthFormat, GLenum *stencilFormat)
 Mimics D3D9RenderSystem::_getDepthStencilFormatFor, if no FBO RTT manager, outputs GL_NONE. More...
 
GLES2Context_getMainContext ()
 Returns the main context. More...
 
virtual void _hlmsBlendblockCreated (HlmsBlendblock *newBlock)
 
virtual void _hlmsBlendblockDestroyed (HlmsBlendblock *block)
 
virtual void _hlmsMacroblockCreated (HlmsMacroblock *newBlock)
 
virtual void _hlmsMacroblockDestroyed (HlmsMacroblock *block)
 
virtual void _hlmsPipelineStateObjectCreated (HlmsPso *newPso)
 
virtual void _hlmsPipelineStateObjectDestroyed (HlmsPso *pso)
 
virtual void _hlmsSamplerblockCreated (HlmsSamplerblock *newBlock)
 
virtual void _hlmsSamplerblockDestroyed (HlmsSamplerblock *block)
 
RenderWindow * _initialise (bool autoCreateWindow, const String &windowTitle="OGRE Render Window")
 See RenderSystem. More...
 
void _makeOrthoMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
 See RenderSystem. More...
 
void _makeProjectionMatrix (const Radian &fovy, Real aspect, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
 See RenderSystem. More...
 
void _makeProjectionMatrix (Real left, Real right, Real bottom, Real top, Real nearPlane, Real farPlane, Matrix4 &dest, bool forGpuProgram=false)
 See RenderSystem. More...
 
void _oneTimeContextInitialization ()
 One time initialization for the RenderState of a context. More...
 
virtual void _render (const CbDrawCallIndexed *cmd)
 Renders the VAO. Assumes _setVertexArrayObject has already been called. More...
 
virtual void _render (const CbDrawCallStrip *cmd)
 
virtual void _render (const v1::CbDrawCallIndexed *cmd)
 Renders a V1 RenderOperation. Assumes _setRenderOperation has already been called. More...
 
virtual void _render (const v1::CbDrawCallStrip *cmd)
 
void _render (const v1::RenderOperation &op)
 See RenderSystem. More...
 
virtual void _renderEmulated (const CbDrawCallIndexed *cmd)
 
virtual void _renderEmulated (const CbDrawCallStrip *cmd)
 
virtual void _renderEmulatedNoBaseInstance (const CbDrawCallIndexed *cmd)
 
virtual void _renderEmulatedNoBaseInstance (const CbDrawCallStrip *cmd)
 
virtual void _renderNoBaseInstance (const v1::CbDrawCallIndexed *cmd)
 
virtual void _renderNoBaseInstance (const v1::CbDrawCallStrip *cmd)
 
virtual void _setComputePso (const HlmsComputePso *pso)
 Unlike _setPipelineStateObject, the RenderSystem will check if the PSO has changed to avoid redundant state changes (since it's hard to do it at Hlms level) More...
 
void _setDepthBias (float constantBias, float slopeScaleBias)
 See RenderSystem. More...
 
void _setDepthBufferCheckEnabled (bool enabled=true)
 See RenderSystem. More...
 
void _setDepthBufferWriteEnabled (bool enabled=true)
 See RenderSystem. More...
 
void _setHlmsBlendblock (const HlmsBlendblock *blendblock, const GLES2HlmsPso *pso)
 
void _setHlmsMacroblock (const HlmsMacroblock *macroblock, const GLES2HlmsPso *pso)
 
virtual void _setHlmsSamplerblock (uint8 texUnit, const HlmsSamplerblock *samplerblock)
 See HlmsSamplerblock. More...
 
virtual void _setHlmsSamplerblockCS (uint8 texUnit, const HlmsSamplerblock *samplerblock)
 
virtual void _setIndirectBuffer (IndirectBufferPacked *indirectBuffer)
 
virtual void _setPipelineStateObject (const HlmsPso *pso)
 
void _setPointParameters (Real size, bool attenuationEnabled, Real constant, Real linear, Real quadratic, Real minSize, Real maxSize)
 See RenderSystem. More...
 
void _setPointSpritesEnabled (bool enabled)
 See RenderSystem. More...
 
void _setProjectionMatrix (const Matrix4 &m)
 See RenderSystem. More...
 
virtual void _setRenderOperation (const v1::CbRenderOp *cmd)
 
void _setRenderTarget (RenderTarget *target, uint8 viewportRenderTargetFlags)
 Set current render target to target, enabling its GL context if needed. More...
 
void _setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendOperation op)
 
void _setSceneBlendingOperation (SceneBlendOperation op)
 
void _setSeparateSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendFactor sourceFactorAlpha, SceneBlendFactor destFactorAlpha, SceneBlendOperation op, SceneBlendOperation alphaOp)
 
void _setSeparateSceneBlendingOperation (SceneBlendOperation op, SceneBlendOperation alphaOp)
 
void _setSurfaceParams (const ColourValue &ambient, const ColourValue &diffuse, const ColourValue &specular, const ColourValue &emissive, Real shininess, TrackVertexColourType tracking)
 See RenderSystem. More...
 
void _setTexture (size_t unit, bool enabled, Texture *tex, bool bDepthReadOnly)
 See RenderSystem. More...
 
void _setTextureBlendMode (size_t stage, const LayerBlendModeEx &bm)
 See RenderSystem. More...
 
void _setTextureCoordCalculation (size_t stage, TexCoordCalcMethod m, const Frustum *frustum=0)
 See RenderSystem. More...
 
virtual void _setTextureCS (uint32 slot, bool enabled, Texture *texPtr)
 
void _setTextureMatrix (size_t stage, const Matrix4 &xform)
 See RenderSystem. More...
 
virtual void _setVertexArrayObject (const VertexArrayObject *vao)
 Part of the low level rendering interface. More...
 
void _setViewMatrix (const Matrix4 &m)
 See RenderSystem. More...
 
void _setViewport (Viewport *vp)
 See RenderSystem. More...
 
void _setWorldMatrix (const Matrix4 &m)
 See RenderSystem. More...
 
virtual void _startLegacyV1Rendering ()
 May override the current VertexArrayObject! More...
 
void _switchContext (GLES2Context *context)
 Switch GL context, dealing with involved internal cached states too. More...
 
void _unregisterContext (GLES2Context *context)
 Unregister a render target->context mapping. More...
 
void _useLights (const LightList &lights, unsigned short limit)
 See RenderSystem. More...
 
bool areFixedFunctionLightsInViewSpace () const
 See RenderSystem. More...
 
virtual void beginGPUSampleProfile (const String &name, uint32 *hashCache)
 
virtual void beginProfileEvent (const String &eventName)
 This marks the beginning of an event for GPU profiling. More...
 
void bindGpuProgramParameters (GpuProgramType gptype, GpuProgramParametersSharedPtr params, uint16 mask)
 Bind Gpu program parameters. More...
 
void bindGpuProgramPassIterationParameters (GpuProgramType gptype)
 Only binds Gpu program parameters used for passes that have more than one iteration rendering. More...
 
bool checkExtension (const String &ext) const
 Checks for the presense of an API-specific extension (eg. Vulkan, GL) More...
 
virtual void clearFrameBuffer (unsigned int buffers, const ColourValue &colour=ColourValue::Black, Real depth=1.0f, unsigned short stencil=0)
 
virtual void clearUAVs ()
 
GLint convertCompareFunction (CompareFunction func) const
 
GLint convertStencilOp (StencilOperation op, bool invert=false) const
 
HardwareOcclusionQuerycreateHardwareOcclusionQuery ()
 Create an object for performing hardware occlusion queries. More...
 
virtual MultiRenderTarget * createMultiRenderTarget (const String &name)
 
virtual RenderSystemCapabilitiescreateRenderSystemCapabilities () const
 See RenderSystem. More...
 
virtual void deinitGPUProfiling ()
 
void destroyRenderWindow (RenderWindow *pWin)
 See RenderSystem. More...
 
virtual void discardFrameBuffer (unsigned int buffers)
 
void enableClipPlane (ushort index, bool enable)
 See RenderSystem. More...
 
virtual void endGPUSampleProfile (const String &name)
 
virtual void endProfileEvent ()
 Ends the currently active GPU profiling event. More...
 
VertexElementType getColourVertexElementType () const
 See RenderSystem. More...
 
ConfigOptionMapgetConfigOptions ()
 See RenderSystem. More...
 
unsigned int getDisplayMonitorCount () const
 Gets the number of display monitors. More...
 
String getErrorDescription (long errorNumber) const
 See RenderSystem. More...
 
const StringgetFriendlyName () const
 See RenderSystem. More...
 
GLES2SupportgetGLES2Support ()
 
Real getHorizontalTexelOffset ()
 Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...
 
Real getMaximumDepthInputValue ()
 Gets the maximum (farthest) depth value to be used when rendering using identity transforms. More...
 
Real getMinimumDepthInputValue ()
 Gets the minimum (closest) depth value to be used when rendering using identity transforms. More...
 
const StringgetName () const
 See RenderSystem. More...
 
Real getVerticalTexelOffset ()
 Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...
 
virtual bool hasAnisotropicMipMapFilter () const
 See RenderSystem. More...
 
bool hasMinGLVersion (int major, int minor) const
 
virtual void initGPUProfiling ()
 
void initialiseContext (RenderWindow *primary)
 
void initialiseFromRenderSystemCapabilities (RenderSystemCapabilities *caps, RenderTarget *primary)
 See RenderSystem. More...
 
virtual void markProfileEvent (const String &eventName)
 Marks an instantaneous event for graphics profilers. More...
 
 OGRE_MUTEX (mThreadInitMutex)
 
void postExtraThreadsStarted ()
 
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...
 
virtual void queueBindUAV (uint32 slot, TexturePtr texture, ResourceAccess::ResourceAccess access=ResourceAccess::ReadWrite, int32 mipmapLevel=0, int32 textureArrayIndex=0, PixelFormat pixelFormat=PF_UNKNOWN)
 
virtual void queueBindUAV (uint32 slot, UavBufferPacked *buffer, ResourceAccess::ResourceAccess access=ResourceAccess::ReadWrite, size_t offset=0, size_t sizeBytes=0)
 
void registerThread ()
 Register the an additional thread which may make calls to rendersystem-related objects. More...
 
void reinitialise ()
 See RenderSystem. More...
 
void setClipPlane (ushort index, Real A, Real B, Real C, Real D)
 See RenderSystem. More...
 
void setClipPlanesImpl (const Ogre::PlaneList &planeList)
 Internal method used to set the underlying clip planes when needed. More...
 
void setConfigOption (const String &name, const String &value)
 See RenderSystem. More...
 
virtual void setStencilBufferParams (uint32 refValue, const StencilParams &stencilParams)
 See RenderSystem. More...
 
void shutdown ()
 See RenderSystem. More...
 
void unregisterThread ()
 Unregister an additional thread which may make calls to rendersystem-related objects. More...
 
String validateConfigOptions ()
 See RenderSystem. More...
 
- Public Member Functions inherited from Ogre::RenderSystem
 RenderSystem ()
 Default Constructor. More...
 
virtual ~RenderSystem ()
 Destructor. More...
 
void _addMetrics (const RenderingMetrics &newMetrics)
 
virtual void _beginFrameOnce ()
 Signifies the beginning of the main frame. More...
 
void _cleanupDepthBuffers ()
 
virtual void _clearStateAndFlushCommandBuffer ()
 On D3D11 calls ClearState followed by Flush(). More...
 
virtual void _convertOpenVrProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest)
 Converts an OpenVR projection matrix to have the proper depth range and reverse Z settings. More...
 
virtual void _convertProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest)
 Converts a uniform projection matrix to suitable for this render system. More...
 
virtual Window_createRenderWindow (const String &name, uint32 width, uint32 height, bool fullScreen, const NameValuePairList *miscParams=0)=0
 Creates a new rendering window. More...
 
virtual bool _createRenderWindows (const RenderWindowDescriptionList &renderWindowDescriptions, WindowList &createdWindows)
 Creates multiple rendering windows. More...
 
void _dereferenceSharedDepthBuffer (TextureGpu *depthBuffer)
 Releases the reference count on a shared depth buffer. More...
 
virtual void _descriptorSetSamplerCreated (DescriptorSetSampler *newSet)
 
virtual void _descriptorSetSamplerDestroyed (DescriptorSetSampler *set)
 
virtual void _descriptorSetTexture2Created (DescriptorSetTexture2 *newSet)
 
virtual void _descriptorSetTexture2Destroyed (DescriptorSetTexture2 *set)
 
virtual void _descriptorSetTextureCreated (DescriptorSetTexture *newSet)
 
virtual void _descriptorSetTextureDestroyed (DescriptorSetTexture *set)
 
virtual void _descriptorSetUavCreated (DescriptorSetUav *newSet)
 
virtual void _descriptorSetUavDestroyed (DescriptorSetUav *set)
 
virtual void _endFrameOnce ()
 Called once per frame, regardless of how many active workspaces there are. More...
 
Viewport_getCurrentRenderViewport ()
 
virtual const String_getDefaultViewportMaterialScheme () const
 Returns the default material scheme used by the render system. More...
 
virtual void _hlmsComputePipelineStateObjectCreated (HlmsComputePso *newPso)
 
virtual void _hlmsComputePipelineStateObjectDestroyed (HlmsComputePso *newPso)
 
virtual void _makeRsProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest, Real nearPlane, Real farPlane, ProjectionType projectionType)
 Takes a regular source projection matrix in range [-1; 1] and converts it to a projection matrix in 'dest' with reverse Z range [1; 0]. More...
 
virtual RenderSystemContext_pauseFrame ()
 Pause rendering for a frame. More...
 
void _resetMetrics ()
 
virtual void _resumeFrame (RenderSystemContext *context)
 Resume rendering for a frame. More...
 
virtual void _setBindingType (TextureUnitState::BindingType bindigType)
 Set texture unit binding type. More...
 
virtual void _setCurrentDeviceFromTexture (TextureGpu *texture)=0
 Because Ogre doesn't (yet) have the notion of a 'device' or 'GL context', this function lets Ogre know which device should be used by providing a texture. More...
 
virtual void _setGeometryTexture (size_t unit, TextureGpu *tex)
 
virtual void _setSamplers (uint32 slotStart, const DescriptorSetSampler *set)=0
 
virtual void _setSamplersCS (uint32 slotStart, const DescriptorSetSampler *set)=0
 
virtual void _setTessellationDomainTexture (size_t unit, TextureGpu *tex)
 
virtual void _setTessellationHullTexture (size_t unit, TextureGpu *tex)
 
virtual void _setTexture (size_t unit, TextureGpu *texPtr, bool bDepthReadOnly)=0
 Sets the texture to bind to a given 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 _setTextures (uint32 slotStart, const DescriptorSetTexture *set, uint32 hazardousTexIdx)=0
 
virtual void _setTextures (uint32 slotStart, const DescriptorSetTexture2 *set)=0
 
virtual void _setTexturesCS (uint32 slotStart, const DescriptorSetTexture *set)=0
 
virtual void _setTexturesCS (uint32 slotStart, const DescriptorSetTexture2 *set)=0
 
virtual void _setTextureUnitSettings (size_t texUnit, TextureUnitState &tl)
 Utility function for setting all the properties of a texture unit at once. More...
 
virtual void _setUavCS (uint32 slotStart, const DescriptorSetUav *set)=0
 
virtual void _setVertexTexture (size_t unit, TextureGpu *tex)
 Binds a texture to a vertex, geometry, compute, tessellation hull or tessellation domain sampler. More...
 
virtual void _setWorldMatrices (const Matrix4 *m, unsigned short count)
 Sets multiple world matrices (vertex blending). More...
 
void _update ()
 Called once per frame, regardless of how many active workspaces there are. More...
 
virtual void addClipPlane (const Plane &p)
 Add a user clipping plane. More...
 
virtual void addClipPlane (Real A, Real B, Real C, Real D)
 Add a user clipping plane. More...
 
virtual void addListener (Listener *l)
 Adds a listener to the custom events that this render system can raise. More...
 
virtual void beginRenderPassDescriptor (RenderPassDescriptor *desc, TextureGpu *anyTarget, uint8 mipLevel, const Vector4 *viewportSizes, const Vector4 *scissors, uint32 numViewports, bool overlaysEnabled, bool warnIfRtvWasFlushed)
 When the descriptor is set to Load clear, two possible things may happen: More...
 
virtual void clearFrameBuffer (RenderPassDescriptor *renderPassDesc, TextureGpu *anyTarget, uint8 mipLevel)=0
 Immediately clears the whole frame buffer on the selected RenderPassDescriptor. More...
 
virtual void compositorWorkspaceBegin (CompositorWorkspace *workspace, const bool forceBeginFrame)
 See RenderSystem::updateCompositorManager. More...
 
virtual void compositorWorkspaceEnd (CompositorWorkspace *workspace, const bool forceEndFrame)
 See RenderSystem::updateCompositorManager. More...
 
virtual void compositorWorkspaceUpdate (CompositorWorkspace *workspace)
 See RenderSystem::updateCompositorManager. More...
 
virtual 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...
 
virtual RenderPassDescriptorcreateRenderPassDescriptor ()=0
 
virtual void debugAnnotationPop ()
 
virtual void debugAnnotationPush (const String &event)
 Specifically meant to mark passes in RenderDoc. More...
 
virtual void destroyHardwareOcclusionQuery (HardwareOcclusionQuery *hq)
 Destroy a hardware occlusion query object. More...
 
void destroyRenderPassDescriptor (RenderPassDescriptor *renderPassDesc)
 
virtual void destroyRenderWindow (Window *window)
 Destroys a render window. More...
 
virtual void endCopyEncoder ()
 Required when caller will soon start analyzing barriers (e.g. More...
 
virtual void endGpuDebuggerFrameCapture (Window *window, const bool bDiscard=false)
 See RenderSystem::startGpuDebuggerFrameCapture Call this function when you're done capturing a frame. More...
 
virtual void endRenderPassDescriptor ()
 
virtual void executeRenderPassDescriptorDelayedActions ()
 Metal needs to delay RenderCommand creation to the last minute, because we can't issue blit operations (e.g. More...
 
virtual void executeResourceTransition (const ResourceTransitionArray &rstCollection)
 
virtual void flushCommands ()=0
 
BarrierSolvergetBarrierSolver ()
 
BoundUav getBoundUav (size_t slot) const
 
const RenderSystemCapabilitiesgetCapabilities () const
 Gets the capabilities of the render system. More...
 
RenderPassDescriptorgetCurrentPassDescriptor ()
 
ViewportgetCurrentRenderViewports ()
 
virtual void getCustomAttribute (const String &name, void *pData)
 Gets a custom (maybe platform-specific) attribute. More...
 
bool getDebugShaders () const
 
virtual TextureGpugetDepthBufferFor (TextureGpu *colourTexture, uint16 poolId, bool preferDepthTexture, PixelFormatGpu depthBufferFormat)
 
virtual const DriverVersiongetDriverVersion () const
 Returns the driver version. More...
 
v1::HardwareVertexBufferSharedPtr getGlobalInstanceVertexBuffer () const
 Returns the global instance vertex buffer. More...
 
v1::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 getInvertedClipSpaceY () const
 +Y is downwards in NDC (Normalized Device Coordinates). Only Vulkan has this problem. More...
 
virtual bool getInvertVertexWinding () const
 Indicates whether or not the vertex windings set will be inverted for the current render (e.g. More...
 
uint32 getMaxBoundViewports ()
 
const RenderingMetricsgetMetrics () const
 
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...
 
virtual size_t getNumPriorityConfigOptions () const
 Number of priority config options in RenderSystem::getPriorityConfigOption. More...
 
virtual const char * getPriorityConfigOption (size_t idx) const
 Some options depend on other options. More...
 
RENDERDOC_API_1_4_1 * getRenderDocApi ()
 Returns the RenderDoc API handle in case you want to do more advanced functionality than what we expose. More...
 
virtual const StringVectorgetRenderSystemEvents () const
 Gets a list of the rendersystem specific events that this rendersystem can raise. More...
 
virtual Real getRSDepthRange () const
 OpenGL depth is in range [-1;1] so it returns 2.0f; D3D11 & Metal are in range [0;1] so it returns 1.0f;. More...
 
const StencilParamsgetStencilBufferParams () const
 
TextureGpuManagergetTextureGpuManager () const
 
VaoManagergetVaoManager () const
 
bool getWBufferEnabled () const
 Returns true if the renderer will try to use W-buffers when available. More...
 
virtual bool isGpuProgramBound (GpuProgramType gptype)
 Returns whether or not a Gpu program of the given type is currently bound. More...
 
bool isReverseDepth () const
 
virtual bool isSameLayout (ResourceLayout::Layout a, ResourceLayout::Layout b, const TextureGpu *texture, bool bIsDebugCheck) const
 Returns true if 'a' and 'b' internally map to the same layout and should be considered equivalent for a given texture. More...
 
virtual bool isStaticBufferLockable () const
 
bool loadRenderDocApi ()
 Explicitly loads RenderDoc. More...
 
void queueBindUAVs (const DescriptorSetUav *descSetUav)
 Queues the binding of an UAV to the binding point/slot. More...
 
virtual void removeListener (Listener *l)
 Remove a listener to the custom events that this render system can raise. More...
 
virtual void resetClipPlanes ()
 Clears the user clipping region. 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 setDebugShaders (bool bDebugShaders)
 Instructs the RenderSystem to compile shaders without optimizations and with debug information, for easier debugging on APIs that support it. More...
 
virtual 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 v1::HardwareVertexBufferSharedPtr &val)
 Sets the global instance vertex buffer. More...
 
void setGlobalInstanceVertexBufferVertexDeclaration (v1::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 setMetricsRecordingEnabled (bool bEnable)
 
void setUavStartingSlot (uint32 startingSlot)
 In Direct3D11, UAV & RenderTargets share the same slots. More...
 
void setWBufferEnabled (bool enabled)
 Sets whether or not W-buffers are enabled if they are available for this renderer. More...
 
virtual bool startGpuDebuggerFrameCapture (Window *window)
 Programmatically performs a GPU capture when attached to a GPU debugger like RenderDoc or Metal Graphics Debugger. More...
 
virtual bool supportsMultithreadedShaderCompliation () const
 Returns true if RenderSystem supports multithreaded shader and PSO compilation. More...
 
virtual void updateCompositorManager (CompositorManager2 *compositorManager)
 This gives the renderer a chance to perform the compositor update in a special way. More...
 
virtual void useCustomRenderSystemCapabilities (RenderSystemCapabilities *capabilities)
 Force the render system to use the special capabilities. More...
 
virtual bool validateDevice (bool forceDeviceElection=false)
 Some render systems have moments when GPU device is temporarily unavailable, for example when D3D11 device is lost, or when iOS app is in background, etc. More...
 
virtual SampleDescription validateSampleDescription (const SampleDescription &sampleDesc, PixelFormatGpu format)
 Returns supported sample description for requested FSAA mode, with graceful downgrading. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Ogre::RenderSystem
static void addSharedListener (Listener *listener)
 Sets shared listener. More...
 
static void fireSharedEvent (const String &name, const NameValuePairList *params=0)
 
static void removeSharedListener (Listener *listener)
 Remove shared listener to the custom events that this render system can raise. More...
 
static CompareFunction reverseCompareFunction (CompareFunction depthFunc)
 Reverts the compare order e.g. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ GLES2RenderSystem()

Ogre::GLES2RenderSystem::GLES2RenderSystem ( )

◆ ~GLES2RenderSystem()

virtual Ogre::GLES2RenderSystem::~GLES2RenderSystem ( )
virtual

Member Function Documentation

◆ _applyObliqueDepthProjection()

void Ogre::GLES2RenderSystem::_applyObliqueDepthProjection ( Matrix4 matrix,
const Plane plane,
bool  forGpuProgram 
)

◆ _beginFrame()

void Ogre::GLES2RenderSystem::_beginFrame ( )
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _bindTextureUavCS()

virtual void Ogre::GLES2RenderSystem::_bindTextureUavCS ( uint32  slot,
Texture *  texture,
ResourceAccess::ResourceAccess  access,
int32  mipmapLevel,
int32  textureArrayIndex,
PixelFormat  pixelFormat 
)
virtual

◆ _createDepthBufferFor()

DepthBuffer* Ogre::GLES2RenderSystem::_createDepthBufferFor ( RenderTarget *  renderTarget,
bool  exactMatchFormat 
)

◆ _createRenderWindow()

RenderWindow* Ogre::GLES2RenderSystem::_createRenderWindow ( const String name,
unsigned int  width,
unsigned int  height,
bool  fullScreen,
const NameValuePairList miscParams = 0 
)

Creates a new rendering window.

Remarks
This method creates a new rendering window as specified by the paramteters. The rendering system could be responible for only a single window (e.g. in the case of a game), or could be in charge of multiple ones (in the case of a level editor). The option to create the window as a child of another is therefore given. This method will create an appropriate subclass of RenderWindow depending on the API and platform implementation.
After creation, this window can be retrieved using getRenderTarget().
Parameters
nameThe name of the window. Used in other methods later like setRenderTarget and getRenderTarget.
widthThe width of the new window.
heightThe height of the new window.
fullScreenSpecify true to make the window full screen without borders, title bar or menu bar.
miscParamsA 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:
Key Type/Values Default Description Notes
title Any string RenderTarget name The title of the window that will appear in the title bar  
colourDepth 16, 32 Desktop depth Colour depth of the resulting rendering window; only applies if fullScreen Win32 Specific
left Positive integers Centred Screen x coordinate from left  
top Positive integers Centred Screen y coordinate from left  
depthBuffer true, false true Use depth buffer DirectX9 specific
externalWindowHandle Win32: HWND as integer
GLX: poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*)
OS X Cocoa: OgreGLView address as an integer. You can pass NSView or NSWindow too, but should perform OgreGLView callbacks into the Ogre manually. iOS: UIWindow address as an integer
0 (none) External window handle, for embedding the OGRE render in an existing window  
externalGLControl true, false false Let the external window control OpenGL i.e. don't select a pixel format for the window, do not change v-sync and do not swap buffer. When set to true, the calling application is responsible of OpenGL initialization and buffer swapping. It should also create an OpenGL context for its own rendering, Ogre will create one for its use. Then the calling application must also enable Ogre OpenGL context before calling any Ogre function and restore its OpenGL context after these calls. OpenGL specific
externalGLContext Context as Unsigned Long 0 (create own context) Use an externally created GL context OpenGL Specific
parentWindowHandle Win32: HWND as integer
GLX: poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*)
0 (none) Parent window handle, for embedding the OGRE in a child of an external window  
contentScalingFactor Positive Float greater than 1.0 The default content scaling factor of the screen Specifies the CAEAGLLayer content scaling factor. Only supported on iOS 4 or greater. This can be useful to limit the resolution of the OpenGL ES backing store. For example, the iPhone 4's native resolution is 960 x 640. Windows are always 320 x 480, if you would like to limit the display to 720 x 480, specify 1.5 as the scaling factor. iOS Specific  
externalViewHandle UIView pointer as an integer 0 External view handle, for rendering OGRE render in an existing view iOS Specific  
externalViewControllerHandle UIViewController pointer as an integer 0 External view controller handle, for embedding OGRE in an existing view controller iOS Specific  
externalSharegroup EAGLSharegroup pointer as an integer 0 External sharegroup, used to shared GL resources between contexts iOS Specific  
Full Screen true, false false Specify whether to create the window in full screen mode OS X Specific  
MSAA Positive integer (usually 1, 2, 4, 8, 16) 1 Multisample antialiasing factor  
MSAA_Quality Depends on RenderSystem and hardware. Currently supports:
0 ... infinite number (depends on HW)
Blank Full screen antialiasing hint  
displayFrequency Refresh rate in Hertz (e.g. 60, 75, 100) Desktop vsync rate Display frequency rate, for fullscreen mode  
vsync true, false false Synchronize buffer swaps to monitor vsync, eliminating tearing at the expense of a fixed frame rate  
vsyncInterval 1, 2, 3, 4 1 If vsync is enabled, the minimum number of vertical blanks that should occur between renders. For example if vsync is enabled, the refresh rate is 60 and this is set to 2, then the frame rate will be locked at 30.  
border none, fixed, resize resize The type of window border (in windowed mode)  
outerDimensions true, false false Whether the width/height is expressed as the size of the outer window, rather than the content area  
useNVPerfHUD true, false false Enable the use of nVidia NVPerfHUD  
gamma true, false false Enable hardware conversion from linear colour space to gamma colour space on rendering to the window.  
enableDoubleClick true, false false Enable the window to keep track and transmit double click messages. Win32 Specific
MSAA Positive integer (usually 0, 2, 4, 8, 16) 0 Full screen antialiasing factor Android Specific
CSAA Positive integer (usually 0, 2, 4, 8, 16) 0 Coverage sampling factor (https://www.khronos.org/registry/egl/extensions/NV/EGL_NV_coverage_sample.txt) Android Specific
maxColourBufferSize Positive integer (usually 16, 32) 32 Max EGL_BUFFER_SIZE Android Specific
minColourBufferSize Positive integer (usually 16, 32) 16 Min EGL_BUFFER_SIZE Android Specific
maxStencilBufferSize Positive integer (usually 0, 8) 0 EGL_STENCIL_SIZE Android Specific
maxDepthBufferSize Positive integer (usually 0, 16, 24) 16 EGL_DEPTH_SIZE Android Specific

◆ _destroyDepthBuffer()

void Ogre::GLES2RenderSystem::_destroyDepthBuffer ( RenderWindow *  pRenderWnd)

◆ _dispatch()

virtual void Ogre::GLES2RenderSystem::_dispatch ( const HlmsComputePso pso)
virtual

Implements Ogre::RenderSystem.

◆ _endFrame()

void Ogre::GLES2RenderSystem::_endFrame ( )
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _getDepthStencilFormatFor()

void Ogre::GLES2RenderSystem::_getDepthStencilFormatFor ( GLenum  internalColourFormat,
GLenum *  depthFormat,
GLenum *  stencilFormat 
)

Mimics D3D9RenderSystem::_getDepthStencilFormatFor, if no FBO RTT manager, outputs GL_NONE.

◆ _getMainContext()

GLES2Context* Ogre::GLES2RenderSystem::_getMainContext ( )
inline

Returns the main context.

◆ _hlmsBlendblockCreated()

virtual void Ogre::GLES2RenderSystem::_hlmsBlendblockCreated ( HlmsBlendblock newBlock)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsBlendblockDestroyed()

virtual void Ogre::GLES2RenderSystem::_hlmsBlendblockDestroyed ( HlmsBlendblock block)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsMacroblockCreated()

virtual void Ogre::GLES2RenderSystem::_hlmsMacroblockCreated ( HlmsMacroblock newBlock)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsMacroblockDestroyed()

virtual void Ogre::GLES2RenderSystem::_hlmsMacroblockDestroyed ( HlmsMacroblock block)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsPipelineStateObjectCreated()

virtual void Ogre::GLES2RenderSystem::_hlmsPipelineStateObjectCreated ( HlmsPso newPso)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsPipelineStateObjectDestroyed()

virtual void Ogre::GLES2RenderSystem::_hlmsPipelineStateObjectDestroyed ( HlmsPso pso)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsSamplerblockCreated()

virtual void Ogre::GLES2RenderSystem::_hlmsSamplerblockCreated ( HlmsSamplerblock newBlock)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsSamplerblockDestroyed()

virtual void Ogre::GLES2RenderSystem::_hlmsSamplerblockDestroyed ( HlmsSamplerblock block)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _initialise()

RenderWindow* Ogre::GLES2RenderSystem::_initialise ( bool  autoCreateWindow,
const String windowTitle = "OGRE Render Window" 
)
virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ _makeOrthoMatrix()

void Ogre::GLES2RenderSystem::_makeOrthoMatrix ( const Radian fovy,
Real  aspect,
Real  nearPlane,
Real  farPlane,
Matrix4 dest,
bool  forGpuProgram = false 
)

◆ _makeProjectionMatrix() [1/2]

void Ogre::GLES2RenderSystem::_makeProjectionMatrix ( const Radian fovy,
Real  aspect,
Real  nearPlane,
Real  farPlane,
Matrix4 dest,
bool  forGpuProgram = false 
)

◆ _makeProjectionMatrix() [2/2]

void Ogre::GLES2RenderSystem::_makeProjectionMatrix ( Real  left,
Real  right,
Real  bottom,
Real  top,
Real  nearPlane,
Real  farPlane,
Matrix4 dest,
bool  forGpuProgram = false 
)

◆ _oneTimeContextInitialization()

void Ogre::GLES2RenderSystem::_oneTimeContextInitialization ( )

One time initialization for the RenderState of a context.

Things that only need to be set once, like the LightingModel can be defined here.

◆ _render() [1/5]

virtual void Ogre::GLES2RenderSystem::_render ( const CbDrawCallIndexed cmd)
virtual

Renders the VAO. Assumes _setVertexArrayObject has already been called.

Implements Ogre::RenderSystem.

◆ _render() [2/5]

virtual void Ogre::GLES2RenderSystem::_render ( const CbDrawCallStrip cmd)
virtual

Implements Ogre::RenderSystem.

◆ _render() [3/5]

virtual void Ogre::GLES2RenderSystem::_render ( const v1::CbDrawCallIndexed cmd)
virtual

Renders a V1 RenderOperation. Assumes _setRenderOperation has already been called.

Implements Ogre::RenderSystem.

◆ _render() [4/5]

virtual void Ogre::GLES2RenderSystem::_render ( const v1::CbDrawCallStrip cmd)
virtual

Implements Ogre::RenderSystem.

◆ _render() [5/5]

void Ogre::GLES2RenderSystem::_render ( const v1::RenderOperation op)
virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ _renderEmulated() [1/2]

virtual void Ogre::GLES2RenderSystem::_renderEmulated ( const CbDrawCallIndexed cmd)
virtual

Implements Ogre::RenderSystem.

◆ _renderEmulated() [2/2]

virtual void Ogre::GLES2RenderSystem::_renderEmulated ( const CbDrawCallStrip cmd)
virtual

Implements Ogre::RenderSystem.

◆ _renderEmulatedNoBaseInstance() [1/2]

virtual void Ogre::GLES2RenderSystem::_renderEmulatedNoBaseInstance ( const CbDrawCallIndexed cmd)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _renderEmulatedNoBaseInstance() [2/2]

virtual void Ogre::GLES2RenderSystem::_renderEmulatedNoBaseInstance ( const CbDrawCallStrip cmd)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _renderNoBaseInstance() [1/2]

virtual void Ogre::GLES2RenderSystem::_renderNoBaseInstance ( const v1::CbDrawCallIndexed cmd)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _renderNoBaseInstance() [2/2]

virtual void Ogre::GLES2RenderSystem::_renderNoBaseInstance ( const v1::CbDrawCallStrip cmd)
virtual

Reimplemented from Ogre::RenderSystem.

◆ _setComputePso()

virtual void Ogre::GLES2RenderSystem::_setComputePso ( const HlmsComputePso pso)
virtual

Unlike _setPipelineStateObject, the RenderSystem will check if the PSO has changed to avoid redundant state changes (since it's hard to do it at Hlms level)

Implements Ogre::RenderSystem.

◆ _setDepthBias()

void Ogre::GLES2RenderSystem::_setDepthBias ( float  constantBias,
float  slopeScaleBias 
)

◆ _setDepthBufferCheckEnabled()

void Ogre::GLES2RenderSystem::_setDepthBufferCheckEnabled ( bool  enabled = true)

◆ _setDepthBufferWriteEnabled()

void Ogre::GLES2RenderSystem::_setDepthBufferWriteEnabled ( bool  enabled = true)

◆ _setHlmsBlendblock()

void Ogre::GLES2RenderSystem::_setHlmsBlendblock ( const HlmsBlendblock blendblock,
const GLES2HlmsPso pso 
)

◆ _setHlmsMacroblock()

void Ogre::GLES2RenderSystem::_setHlmsMacroblock ( const HlmsMacroblock macroblock,
const GLES2HlmsPso pso 
)

◆ _setHlmsSamplerblock()

virtual void Ogre::GLES2RenderSystem::_setHlmsSamplerblock ( uint8  texUnit,
const HlmsSamplerblock Samplerblock 
)
virtual

See HlmsSamplerblock.

This function MUST be called after _setTexture, not before. Otherwise not all APIs may see the change.

Implements Ogre::RenderSystem.

◆ _setHlmsSamplerblockCS()

virtual void Ogre::GLES2RenderSystem::_setHlmsSamplerblockCS ( uint8  texUnit,
const HlmsSamplerblock samplerblock 
)
virtual

◆ _setIndirectBuffer()

virtual void Ogre::GLES2RenderSystem::_setIndirectBuffer ( IndirectBufferPacked indirectBuffer)
virtual

Implements Ogre::RenderSystem.

◆ _setPipelineStateObject()

virtual void Ogre::GLES2RenderSystem::_setPipelineStateObject ( const HlmsPso pso)
virtual
See also
HlmsPso

Reimplemented from Ogre::RenderSystem.

◆ _setPointParameters()

void Ogre::GLES2RenderSystem::_setPointParameters ( Real  size,
bool  attenuationEnabled,
Real  constant,
Real  linear,
Real  quadratic,
Real  minSize,
Real  maxSize 
)
inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setPointSpritesEnabled()

void Ogre::GLES2RenderSystem::_setPointSpritesEnabled ( bool  enabled)
inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setProjectionMatrix()

void Ogre::GLES2RenderSystem::_setProjectionMatrix ( const Matrix4 m)
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setRenderOperation()

virtual void Ogre::GLES2RenderSystem::_setRenderOperation ( const v1::CbRenderOp cmd)
virtual

Implements Ogre::RenderSystem.

◆ _setRenderTarget()

void Ogre::GLES2RenderSystem::_setRenderTarget ( RenderTarget *  target,
uint8  viewportRenderTargetFlags 
)

Set current render target to target, enabling its GL context if needed.

◆ _setSceneBlending()

void Ogre::GLES2RenderSystem::_setSceneBlending ( SceneBlendFactor  sourceFactor,
SceneBlendFactor  destFactor,
SceneBlendOperation  op 
)

◆ _setSceneBlendingOperation()

void Ogre::GLES2RenderSystem::_setSceneBlendingOperation ( SceneBlendOperation  op)

◆ _setSeparateSceneBlending()

void Ogre::GLES2RenderSystem::_setSeparateSceneBlending ( SceneBlendFactor  sourceFactor,
SceneBlendFactor  destFactor,
SceneBlendFactor  sourceFactorAlpha,
SceneBlendFactor  destFactorAlpha,
SceneBlendOperation  op,
SceneBlendOperation  alphaOp 
)

◆ _setSeparateSceneBlendingOperation()

void Ogre::GLES2RenderSystem::_setSeparateSceneBlendingOperation ( SceneBlendOperation  op,
SceneBlendOperation  alphaOp 
)

◆ _setSurfaceParams()

void Ogre::GLES2RenderSystem::_setSurfaceParams ( const ColourValue ambient,
const ColourValue diffuse,
const ColourValue specular,
const ColourValue emissive,
Real  shininess,
TrackVertexColourType  tracking 
)
inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setTexture()

void Ogre::GLES2RenderSystem::_setTexture ( size_t  unit,
bool  enabled,
Texture *  tex,
bool  bDepthReadOnly 
)

◆ _setTextureBlendMode()

void Ogre::GLES2RenderSystem::_setTextureBlendMode ( size_t  stage,
const LayerBlendModeEx bm 
)
inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setTextureCoordCalculation()

void Ogre::GLES2RenderSystem::_setTextureCoordCalculation ( size_t  stage,
TexCoordCalcMethod  m,
const Frustum frustum = 0 
)
inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setTextureCS()

virtual void Ogre::GLES2RenderSystem::_setTextureCS ( uint32  slot,
bool  enabled,
Texture *  texPtr 
)
virtual

◆ _setTextureMatrix()

void Ogre::GLES2RenderSystem::_setTextureMatrix ( size_t  stage,
const Matrix4 xform 
)
inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setVertexArrayObject()

virtual void Ogre::GLES2RenderSystem::_setVertexArrayObject ( const VertexArrayObject vao)
virtual

Part of the low level rendering interface.

Tells the RS which VAO will be bound now. (i.e. Vertex Formats, buffers being bound, etc.) You don't need to rebind if the VAO's mRenderQueueId is the same as previous call.

Remarks
Assumes _setPipelineStateObject has already been called.

Implements Ogre::RenderSystem.

◆ _setViewMatrix()

void Ogre::GLES2RenderSystem::_setViewMatrix ( const Matrix4 m)
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setViewport()

void Ogre::GLES2RenderSystem::_setViewport ( Viewport vp)

◆ _setWorldMatrix()

void Ogre::GLES2RenderSystem::_setWorldMatrix ( const Matrix4 m)
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _startLegacyV1Rendering()

virtual void Ogre::GLES2RenderSystem::_startLegacyV1Rendering ( )
virtual

May override the current VertexArrayObject!

Reimplemented from Ogre::RenderSystem.

◆ _switchContext()

void Ogre::GLES2RenderSystem::_switchContext ( GLES2Context context)

Switch GL context, dealing with involved internal cached states too.

◆ _unregisterContext()

void Ogre::GLES2RenderSystem::_unregisterContext ( GLES2Context context)

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.

Note
This is automatically called by the destructor of GLES2Context.

◆ _useLights()

void Ogre::GLES2RenderSystem::_useLights ( const LightList lights,
unsigned short  limit 
)
inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ areFixedFunctionLightsInViewSpace()

bool Ogre::GLES2RenderSystem::areFixedFunctionLightsInViewSpace ( ) const
inlinevirtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ beginGPUSampleProfile()

virtual void Ogre::GLES2RenderSystem::beginGPUSampleProfile ( const String name,
uint32 hashCache 
)
virtual

Implements Ogre::RenderSystem.

◆ beginProfileEvent()

virtual void Ogre::GLES2RenderSystem::beginProfileEvent ( const String eventName)
virtual

This marks the beginning of an event for GPU profiling.

Implements Ogre::RenderSystem.

◆ bindGpuProgramParameters()

void Ogre::GLES2RenderSystem::bindGpuProgramParameters ( GpuProgramType  gptype,
GpuProgramParametersSharedPtr  params,
uint16  variabilityMask 
)
virtual

Bind Gpu program parameters.

Parameters
gptypeThe type of program to bind the parameters to
paramsThe parameters to bind
variabilityMaskA mask of GpuParamVariability identifying which params need binding

Implements Ogre::RenderSystem.

◆ bindGpuProgramPassIterationParameters()

void Ogre::GLES2RenderSystem::bindGpuProgramPassIterationParameters ( GpuProgramType  gptype)
virtual

Only binds Gpu program parameters used for passes that have more than one iteration rendering.

Implements Ogre::RenderSystem.

◆ checkExtension()

bool Ogre::GLES2RenderSystem::checkExtension ( const String ext) const
virtual

Checks for the presense of an API-specific extension (eg. Vulkan, GL)

Reimplemented from Ogre::RenderSystem.

◆ clearFrameBuffer()

virtual void Ogre::GLES2RenderSystem::clearFrameBuffer ( unsigned int  buffers,
const ColourValue colour = ColourValue::Black,
Real  depth = 1.0f,
unsigned short  stencil = 0 
)
virtual

◆ clearUAVs()

virtual void Ogre::GLES2RenderSystem::clearUAVs ( )
virtual

◆ convertCompareFunction()

GLint Ogre::GLES2RenderSystem::convertCompareFunction ( CompareFunction  func) const

◆ convertStencilOp()

GLint Ogre::GLES2RenderSystem::convertStencilOp ( StencilOperation  op,
bool  invert = false 
) const

◆ createHardwareOcclusionQuery()

HardwareOcclusionQuery* Ogre::GLES2RenderSystem::createHardwareOcclusionQuery ( )
virtual

Create an object for performing hardware occlusion queries.

Implements Ogre::RenderSystem.

◆ createMultiRenderTarget()

virtual MultiRenderTarget* Ogre::GLES2RenderSystem::createMultiRenderTarget ( const String name)
virtual

◆ createRenderSystemCapabilities()

virtual RenderSystemCapabilities* Ogre::GLES2RenderSystem::createRenderSystemCapabilities ( ) const
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ deinitGPUProfiling()

virtual void Ogre::GLES2RenderSystem::deinitGPUProfiling ( )
virtual

Implements Ogre::RenderSystem.

◆ destroyRenderWindow()

void Ogre::GLES2RenderSystem::destroyRenderWindow ( RenderWindow *  pWin)

◆ discardFrameBuffer()

virtual void Ogre::GLES2RenderSystem::discardFrameBuffer ( unsigned int  buffers)
virtual

◆ enableClipPlane()

void Ogre::GLES2RenderSystem::enableClipPlane ( ushort  index,
bool  enable 
)

◆ endGPUSampleProfile()

virtual void Ogre::GLES2RenderSystem::endGPUSampleProfile ( const String name)
virtual

Implements Ogre::RenderSystem.

◆ endProfileEvent()

virtual void Ogre::GLES2RenderSystem::endProfileEvent ( )
virtual

Ends the currently active GPU profiling event.

Implements Ogre::RenderSystem.

◆ getColourVertexElementType()

VertexElementType Ogre::GLES2RenderSystem::getColourVertexElementType ( ) const
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ getConfigOptions()

ConfigOptionMap& Ogre::GLES2RenderSystem::getConfigOptions ( )
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ getDisplayMonitorCount()

unsigned int Ogre::GLES2RenderSystem::getDisplayMonitorCount ( ) const
virtual

Gets the number of display monitors.

See also
Root::getDisplayMonitorCount

Implements Ogre::RenderSystem.

◆ getErrorDescription()

String Ogre::GLES2RenderSystem::getErrorDescription ( long  errorNumber) const
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ getFriendlyName()

const String& Ogre::GLES2RenderSystem::getFriendlyName ( ) const
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ getGLES2Support()

GLES2Support* Ogre::GLES2RenderSystem::getGLES2Support ( )
inline

◆ getHorizontalTexelOffset()

Real Ogre::GLES2RenderSystem::getHorizontalTexelOffset ( )
inlinevirtual

Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem.

Remarks
Since rendersystems sometimes disagree on the origin of a texel, mapping from texels to pixels can sometimes be problematic to implement generically. This method allows you to retrieve the offset required to map the origin of a texel to the origin of a pixel in the horizontal direction.

Implements Ogre::RenderSystem.

◆ getMaximumDepthInputValue()

Real Ogre::GLES2RenderSystem::getMaximumDepthInputValue ( )
inlinevirtual

Gets the maximum (farthest) depth value to be used when rendering using identity transforms.

Remarks
When using identity transforms you can manually set the depth of a vertex; however the input values required differ per rendersystem. This method lets you retrieve the correct value.
See also
Renderable::getUseIdentityView, Renderable::getUseIdentityProjection

Implements Ogre::RenderSystem.

◆ getMinimumDepthInputValue()

Real Ogre::GLES2RenderSystem::getMinimumDepthInputValue ( )
inlinevirtual

Gets the minimum (closest) depth value to be used when rendering using identity transforms.

Remarks
When using identity transforms you can manually set the depth of a vertex; however the input values required differ per rendersystem. This method lets you retrieve the correct value.
See also
Renderable::getUseIdentityView, Renderable::getUseIdentityProjection

Implements Ogre::RenderSystem.

◆ getName()

const String& Ogre::GLES2RenderSystem::getName ( ) const
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ getVerticalTexelOffset()

Real Ogre::GLES2RenderSystem::getVerticalTexelOffset ( )
inlinevirtual

Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem.

Remarks
Since rendersystems sometimes disagree on the origin of a texel, mapping from texels to pixels can sometimes be problematic to implement generically. This method allows you to retrieve the offset required to map the origin of a texel to the origin of a pixel in the vertical direction.

Implements Ogre::RenderSystem.

◆ hasAnisotropicMipMapFilter()

virtual bool Ogre::GLES2RenderSystem::hasAnisotropicMipMapFilter ( ) const
inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ hasMinGLVersion()

bool Ogre::GLES2RenderSystem::hasMinGLVersion ( int  major,
int  minor 
) const

◆ initGPUProfiling()

virtual void Ogre::GLES2RenderSystem::initGPUProfiling ( )
virtual

Implements Ogre::RenderSystem.

◆ initialiseContext()

void Ogre::GLES2RenderSystem::initialiseContext ( RenderWindow *  primary)

◆ initialiseFromRenderSystemCapabilities()

void Ogre::GLES2RenderSystem::initialiseFromRenderSystemCapabilities ( RenderSystemCapabilities caps,
RenderTarget *  primary 
)

◆ markProfileEvent()

virtual void Ogre::GLES2RenderSystem::markProfileEvent ( const String eventName)
virtual

Marks an instantaneous event for graphics profilers.

This is equivalent to calling beginProfileEvent() and endProfileEvent() back to back.

Implements Ogre::RenderSystem.

◆ OGRE_MUTEX()

Ogre::GLES2RenderSystem::OGRE_MUTEX ( mThreadInitMutex  )

◆ postExtraThreadsStarted()

void Ogre::GLES2RenderSystem::postExtraThreadsStarted ( )
virtual

Implements Ogre::RenderSystem.

◆ preExtraThreadsStarted()

void Ogre::GLES2RenderSystem::preExtraThreadsStarted ( )
virtual

Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered.

Remarks
Call this from your main thread before starting your other threads (which themselves should call registerThread()). Note that if you start your own threads, there is a specific startup sequence which must be respected and requires synchronisation between the threads:
  1. [Main thread]Call preExtraThreadsStarted
  2. [Main thread]Start other thread, wait
  3. [Other thread]Call registerThread, notify main thread & continue
  4. [Main thread]Wake up & call postExtraThreadsStarted
Once this init sequence is completed the threads are independent but this startup sequence must be respected.

Implements Ogre::RenderSystem.

◆ queueBindUAV() [1/2]

virtual void Ogre::GLES2RenderSystem::queueBindUAV ( uint32  slot,
TexturePtr  texture,
ResourceAccess::ResourceAccess  access = ResourceAccess::ReadWrite,
int32  mipmapLevel = 0,
int32  textureArrayIndex = 0,
PixelFormat  pixelFormat = PF_UNKNOWN 
)
virtual

◆ queueBindUAV() [2/2]

virtual void Ogre::GLES2RenderSystem::queueBindUAV ( uint32  slot,
UavBufferPacked buffer,
ResourceAccess::ResourceAccess  access = ResourceAccess::ReadWrite,
size_t  offset = 0,
size_t  sizeBytes = 0 
)
virtual

◆ registerThread()

void Ogre::GLES2RenderSystem::registerThread ( )
virtual

Register the an additional thread which may make calls to rendersystem-related objects.

Remarks
This method should only be called by additional threads during their initialisation. If they intend to use hardware rendering system resources they should call this method before doing anything related to the render system. Some rendering APIs require a per-thread setup and this method will sort that out. It is also necessary to call unregisterThread before the thread shuts down.
Note
This method takes no parameters - it must be called from the thread being registered and that context is enough.

Implements Ogre::RenderSystem.

◆ reinitialise()

void Ogre::GLES2RenderSystem::reinitialise ( )
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ setClipPlane()

void Ogre::GLES2RenderSystem::setClipPlane ( ushort  index,
Real  A,
Real  B,
Real  C,
Real  D 
)

◆ setClipPlanesImpl()

void Ogre::GLES2RenderSystem::setClipPlanesImpl ( const Ogre::PlaneList clipPlanes)
inlinevirtual

Internal method used to set the underlying clip planes when needed.

Implements Ogre::RenderSystem.

◆ setConfigOption()

void Ogre::GLES2RenderSystem::setConfigOption ( const String name,
const String value 
)
virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ setStencilBufferParams()

virtual void Ogre::GLES2RenderSystem::setStencilBufferParams ( uint32  refValue,
const StencilParams stencilParams 
)
virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ shutdown()

void Ogre::GLES2RenderSystem::shutdown ( )
virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ unregisterThread()

void Ogre::GLES2RenderSystem::unregisterThread ( )
virtual

Unregister an additional thread which may make calls to rendersystem-related objects.

See also
RenderSystem::registerThread

Implements Ogre::RenderSystem.

◆ validateConfigOptions()

String Ogre::GLES2RenderSystem::validateConfigOptions ( )
virtual

See RenderSystem.

Implements Ogre::RenderSystem.


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