OGRE
13.6
Object-Oriented Graphics Rendering Engine
|
Implementation of GL ES 2.x as a rendering system. More...
Classes | |
class | Ogre::GLES2RenderSystem |
Implementation of GL ES 2.x as a rendering system. More... | |
Functions | |
Ogre::GLES2RenderSystem::GLES2RenderSystem () | |
virtual | Ogre::GLES2RenderSystem::~GLES2RenderSystem () |
void | Ogre::GLES2RenderSystem::_bindVao (GLContext *context, uint32 vao) override |
Bind VAO, context should be equal to current context, as VAOs are not shared More... | |
void | Ogre::GLES2RenderSystem::_copyContentsToMemory (Viewport *vp, const Box &src, const PixelBox &dst, RenderWindow::FrameBuffer buffer) override |
Copies the current contents of the render target to a pixelbox. More... | |
DepthBuffer * | Ogre::GLES2RenderSystem::_createDepthBufferFor (RenderTarget *renderTarget) override |
Creates a DepthBuffer that can be attached to the specified RenderTarget. More... | |
RenderWindow * | Ogre::GLES2RenderSystem::_createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0) override |
Creates a new rendering window. More... | |
uint32 | Ogre::GLES2RenderSystem::_createVao () override |
Create VAO on current context. More... | |
void | Ogre::GLES2RenderSystem::_destroyDepthBuffer (RenderTarget *pRenderWnd) |
void | Ogre::GLES2RenderSystem::_destroyFbo (GLContext *context, uint32 fbo) override |
Destroy FBO immediately or defer if it was created on other context. More... | |
void | Ogre::GLES2RenderSystem::_destroyVao (GLContext *context, uint32 vao) override |
Destroy VAO immediately or defer if it was created on other context. More... | |
void | Ogre::GLES2RenderSystem::_endFrame (void) override |
Ends rendering of a frame to the current viewport. More... | |
GLES2StateCacheManager * | Ogre::GLES2RenderSystem::_getStateCacheManager () |
void | Ogre::GLES2RenderSystem::_initialise () override |
Start up the renderer using the settings selected (Or the defaults if none have been selected). More... | |
void | Ogre::GLES2RenderSystem::_oneTimeContextInitialization () override |
One time initialization for the RenderState of a context. More... | |
void | Ogre::GLES2RenderSystem::_render (const RenderOperation &op) override |
Render something to the active viewport. More... | |
void | Ogre::GLES2RenderSystem::_setAlphaRejectSettings (CompareFunction func, unsigned char value, bool alphaToCoverage) override |
Sets the global alpha rejection approach for future renders. More... | |
void | Ogre::GLES2RenderSystem::_setCullingMode (CullingMode mode) override |
Sets the culling mode for the render system based on the 'vertex winding'. More... | |
void | Ogre::GLES2RenderSystem::_setDepthBias (float constantBias, float slopeScaleBias) override |
Sets the depth bias, NB you should use the Material version of this. More... | |
void | Ogre::GLES2RenderSystem::_setDepthBufferCheckEnabled (bool enabled=true) override |
void | Ogre::GLES2RenderSystem::_setDepthBufferFunction (CompareFunction func=CMPF_LESS_EQUAL) override |
void | Ogre::GLES2RenderSystem::_setDepthBufferParams (bool depthTest=true, bool depthWrite=true, CompareFunction depthFunction=CMPF_LESS_EQUAL) override |
Sets the mode of operation for depth buffer tests from this point onwards. More... | |
void | Ogre::GLES2RenderSystem::_setDepthBufferWriteEnabled (bool enabled=true) override |
void | Ogre::GLES2RenderSystem::_setLineWidth (float width) override |
Set the line width when drawing as RenderOperation::OT_LINE_LIST/ RenderOperation::OT_LINE_STRIP. More... | |
void | Ogre::GLES2RenderSystem::_setPolygonMode (PolygonMode level) override |
Sets how to rasterise triangles, as points, wireframe or solid polys. More... | |
void | Ogre::GLES2RenderSystem::_setRenderTarget (RenderTarget *target) override |
Set current render target to target, enabling its GL context if needed. More... | |
void | Ogre::GLES2RenderSystem::_setSampler (size_t unit, Sampler &sampler) override |
set the sampler settings for the given texture unit More... | |
void | Ogre::GLES2RenderSystem::_setTexture (size_t unit, bool enabled, const TexturePtr &tex) override |
Sets the texture to bind to a given texture unit. More... | |
void | Ogre::GLES2RenderSystem::_setTextureAddressingMode (size_t stage, const Sampler::UVWAddressingMode &uvw) override |
void | Ogre::GLES2RenderSystem::_setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter) override |
void | Ogre::GLES2RenderSystem::_setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter) override |
void | Ogre::GLES2RenderSystem::_setViewport (Viewport *vp) override |
Sets the provided viewport as the active one for future rendering operations. More... | |
void | Ogre::GLES2RenderSystem::_switchContext (GLContext *context) |
Switch GL context, dealing with involved internal cached states too. More... | |
void | Ogre::GLES2RenderSystem::_unregisterContext (GLContext *context) override |
Unregister a render target->context mapping. More... | |
void | Ogre::GLES2RenderSystem::beginProfileEvent (const String &eventName) override |
This marks the beginning of an event for GPU profiling. More... | |
void | Ogre::GLES2RenderSystem::bindGpuProgram (GpuProgram *prg) override |
Binds a given GpuProgram (but not the parameters). More... | |
void | Ogre::GLES2RenderSystem::bindGpuProgramParameters (GpuProgramType gptype, const GpuProgramParametersPtr ¶ms, uint16 mask) override |
Bind Gpu program parameters. More... | |
void | Ogre::GLES2RenderSystem::clearFrameBuffer (unsigned int buffers, const ColourValue &colour=ColourValue::Black, float depth=1.0f, unsigned short stencil=0) override |
GLint | Ogre::GLES2RenderSystem::convertCompareFunction (CompareFunction func) const |
GLint | Ogre::GLES2RenderSystem::convertStencilOp (StencilOperation op, bool invert=false) const |
HardwareOcclusionQuery * | Ogre::GLES2RenderSystem::createHardwareOcclusionQuery (void) override |
Create an object for performing hardware occlusion queries. More... | |
MultiRenderTarget * | Ogre::GLES2RenderSystem::createMultiRenderTarget (const String &name) override |
Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. More... | |
RenderSystemCapabilities * | Ogre::GLES2RenderSystem::createRenderSystemCapabilities () const override |
Query the real capabilities of the GPU and driver in the RenderSystem. More... | |
void | Ogre::GLES2RenderSystem::destroyRenderWindow (const String &name) override |
Destroys a render window. More... | |
void | Ogre::GLES2RenderSystem::endProfileEvent (void) override |
Ends the currently active GPU profiling event. More... | |
const String & | Ogre::GLES2RenderSystem::getName (void) const override |
Returns the name of the rendering system. More... | |
void | Ogre::GLES2RenderSystem::initialiseContext (RenderWindow *primary) |
void | Ogre::GLES2RenderSystem::initialiseFromRenderSystemCapabilities (RenderSystemCapabilities *caps, RenderTarget *primary) override |
Initialize the render system from the capabilities. More... | |
void | Ogre::GLES2RenderSystem::markProfileEvent (const String &eventName) override |
Marks an instantaneous event for graphics profilers. More... | |
void | Ogre::GLES2RenderSystem::setColourBlendState (const ColourBlendState &state) override |
Sets the global blending factors for combining subsequent renders with the existing frame contents. More... | |
void | Ogre::GLES2RenderSystem::setScissorTest (bool enabled, const Rect &rect=Rect()) override |
Sets the 'scissor region' i.e. More... | |
void | Ogre::GLES2RenderSystem::setStencilState (const StencilState &state) override |
This method allows you to set all the stencil buffer parameters in one call. More... | |
void | Ogre::GLES2RenderSystem::shutdown (void) override |
Shutdown the renderer and cleanup resources. More... | |
void | Ogre::GLES2RenderSystem::unbindGpuProgram (GpuProgramType gptype) override |
Unbinds GpuPrograms of a given GpuProgramType. More... | |
Implementation of GL ES 2.x as a rendering system.
Ogre::GLES2RenderSystem::GLES2RenderSystem | ( | ) |
|
virtual |
|
overridevirtual |
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.
|
overridevirtual |
Query the real capabilities of the GPU and driver in the RenderSystem.
Implements Ogre::RenderSystem.
|
overridevirtual |
Initialize the render system from the capabilities.
Implements Ogre::RenderSystem.
|
overridevirtual |
Shutdown the renderer and cleanup resources.
Reimplemented from Ogre::RenderSystem.
|
overridevirtual |
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: |
Key | Type / Values | Default | Description | Platform |
---|---|---|---|---|
title | String | RenderTarget name | The title of the window that will appear in the title bar | |
left | Positive integers | Centred | Screen x coordinate from left | |
top | Positive integers | Centred | Screen y coordinate from left | |
hidden | true, false | false | hide the created window | |
FSAA | Positive integer (usually 0, 2, 4, 8, 16) | 0 | Full screen antialiasing factor | |
gamma | true, false | false | Enable hardware conversion from linear colour space to gamma colour space on rendering to the window. | |
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. | |
Full Screen | true, false | false | Specify whether to create the window in full screen mode | |
border | none, fixed, resize | resize | The type of window border (in windowed mode) | Windows, OSX |
displayFrequency | Refresh rate in Hertz (e.g. 60, 75, 100) | Desktop vsync rate | Display frequency rate, for fullscreen mode | |
externalWindowHandle |
| 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 |
currentGLContext | true, false | false | Use an externally created GL context. (Must be current) | OpenGL |
minColourBufferSize | Positive integer (usually 16, 32) | 16 | Min total colour buffer size. See EGL_BUFFER_SIZE | OpenGL |
windowProc | WNDPROC | DefWindowProc | function that processes window messages | Win 32 |
colourDepth | 16, 32 | Desktop depth | Colour depth of the resulting rendering window; only applies if fullScreen | Win32 |
FSAAHint | RenderSystem specific. Currently enables EQAA/ CSAA mode on D3D: if you want 4f8x (8x CSAA), set FSAA=4 and this to "f8" | Blank | FSAA mode hint | D3D |
outerDimensions | true, false | false | Whether the width/height is expressed as the size of the outer window, rather than the content area | Win32 |
monitorIndex | -1 | Win 32 | ||
monitorHandle | 0 (none) | Win 32 (OpenGL) | ||
enableDoubleClick | true, false | false | Enable the window to keep track and transmit double click messages. | Win32 |
useNVPerfHUD | true, false | false | Enable the use of nVidia NVPerfHUD | D3D |
depthBuffer | true, false | true | Use depth buffer | D3D |
NSOpenGLCPSurfaceOrder | -1 or 1 | 1 | NSOpenGLCPSurfaceOrder | OSX |
contentScalingFactor | Positive Float | The default content scaling factor of the screen | On IOS specifies the CAEAGLLayer content scaling factor. 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. | OSX, iOS, Android |
externalViewHandle | UIView pointer as an integer | 0 | External view handle, for rendering OGRE render in an existing view | iOS |
externalViewControllerHandle | UIViewController pointer as an integer | 0 | External view controller handle, for embedding OGRE in an existing view controller | iOS |
externalSharegroup | EAGLSharegroup pointer as an integer | 0 | External sharegroup, used to shared GL resources between contexts | iOS |
CSAA | Positive integer (usually 0, 2, 4, 8, 16) | 0 | Coverage sampling factor | Android |
maxColourBufferSize | Positive integer (usually 16, 32) | 32 | Max EGL_BUFFER_SIZE | Android |
maxStencilBufferSize | Positive integer (usually 0, 8) | 0 | EGL_STENCIL_SIZE | Android |
maxDepthBufferSize | Positive integer (usually 0, 16, 24) | 16 | EGL_DEPTH_SIZE | Android |
Reimplemented from Ogre::RenderSystem.
|
overridevirtual |
Creates a DepthBuffer that can be attached to the specified RenderTarget.
Implements Ogre::RenderSystem.
|
overridevirtual |
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.
|
overridevirtual |
Destroys a render window.
Reimplemented from Ogre::RenderSystem.
|
overridevirtual |
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.
|
overridevirtual |
set the sampler settings for the given texture unit
Implements Ogre::RenderSystem.
|
overridevirtual |
Reimplemented from Ogre::RenderSystem.
|
overridevirtual |
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.
|
overridevirtual |
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.
|
overridevirtual |
Ends rendering of a frame to the current viewport.
Implements Ogre::RenderSystem.
|
overridevirtual |
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 either be clockwise or anticlockwise (that's 'counterclockwise' for you Americans out there ;) The default is Ogre::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 Ogre::CULL_NONE option for mesh data that you cull yourself where the vertex winding is uncertain or for creating 2-sided passes.
Implements Ogre::RenderSystem.
|
overridevirtual |
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.
|
overridevirtual |
Reimplemented from Ogre::RenderSystem.
|
overridevirtual |
Reimplemented from Ogre::RenderSystem.
|
overridevirtual |
Reimplemented from Ogre::RenderSystem.
|
overridevirtual |
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.
|
overridevirtual |
Sets the global blending factors for combining subsequent renders with the existing frame contents.
Implements Ogre::RenderSystem.
|
overridevirtual |
Sets how to rasterise triangles, as points, wireframe or solid polys.
Implements Ogre::RenderSystem.
|
overridevirtual |
This method allows you to set all the stencil buffer parameters in one call.
Unlike other render states, stencilling is left for the application to turn on and off when it requires. This is because you are likely to want to change parameters between batches of arbitrary objects and control the ordering yourself. In order to batch things this way, you'll want to use OGRE's Compositor stencil pass or separate render queue groups and register a RenderQueueListener to get notifications between batches.
Implements Ogre::RenderSystem.
|
overridevirtual |
Reimplemented from Ogre::RenderSystem.
|
overridevirtual |
Reimplemented from Ogre::RenderSystem.
|
overridevirtual |
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.
|
overridevirtual |
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. |
rect | The location of the corners of the rectangle, expressed in pixels. |
Implements Ogre::RenderSystem.
|
override |
|
overridevirtual |
Create an object for performing hardware occlusion queries.
Implements Ogre::RenderSystem.
|
inline |
|
overridevirtual |
Create VAO on current context.
Reimplemented from Ogre::GLRenderSystemCommon.
Bind VAO, context should be equal to current context, as VAOs are not shared
Reimplemented from Ogre::GLRenderSystemCommon.
Destroy VAO immediately or defer if it was created on other context.
Reimplemented from Ogre::GLRenderSystemCommon.
Destroy FBO immediately or defer if it was created on other context.
Reimplemented from Ogre::GLRenderSystemCommon.
|
overridevirtual |
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.
void Ogre::GLES2RenderSystem::_switchContext | ( | GLContext * | context | ) |
Switch GL context, dealing with involved internal cached states too.
|
overridevirtual |
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::GLES2RenderSystem::initialiseContext | ( | RenderWindow * | primary | ) |
|
overridevirtual |
Set current render target to target, enabling its GL context if needed.
Implements Ogre::RenderSystem.
GLint Ogre::GLES2RenderSystem::convertCompareFunction | ( | CompareFunction | func | ) | const |
GLint Ogre::GLES2RenderSystem::convertStencilOp | ( | StencilOperation | op, |
bool | invert = false |
||
) | const |
|
overridevirtual |
Binds a given GpuProgram (but not the parameters).
Reimplemented from Ogre::RenderSystem.
|
overridevirtual |
Unbinds GpuPrograms of a given GpuProgramType.
Reimplemented from Ogre::RenderSystem.
|
overridevirtual |
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.
|
overridevirtual |
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.
void Ogre::GLES2RenderSystem::_destroyDepthBuffer | ( | RenderTarget * | pRenderWnd | ) |
|
overridevirtual |
This marks the beginning of an event for GPU profiling.
Implements Ogre::RenderSystem.
|
overridevirtual |
Ends the currently active GPU profiling event.
Implements Ogre::RenderSystem.
|
overridevirtual |
Marks an instantaneous event for graphics profilers.
This is equivalent to calling
Implements Ogre::RenderSystem.
|
overridevirtual |
Copies the current contents of the render target to a pixelbox.
Implements Ogre::GLRenderSystemCommon.