![]() |
OGRE 14.3
Object-Oriented Graphics Rendering Engine
|
Implementation of GL 3 as a rendering system. More...
#include <OgreGL3PlusRenderSystem.h>
Public Member Functions | |
GL3PlusRenderSystem () | |
~GL3PlusRenderSystem () | |
void | _bindVao (GLContext *context, uint32 vao) override |
Bind VAO, context should be equal to current context, as VAOs are not shared. | |
void | _copyContentsToMemory (Viewport *vp, const Box &src, const PixelBox &dst, RenderWindow::FrameBuffer buffer) override |
Copies the current contents of the render target to a pixelbox. | |
DepthBuffer * | _createDepthBufferFor (RenderTarget *renderTarget) override |
Creates a DepthBuffer that can be attached to the specified RenderTarget. | |
RenderWindow * | _createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0) override |
Creates a new rendering window. | |
uint32 | _createVao () override |
Create VAO on current context. | |
void | _destroyFbo (GLContext *context, uint32 fbo) override |
Destroy FBO immediately or defer if it was created on other context. | |
void | _destroyVao (GLContext *context, uint32 vao) override |
Destroy VAO immediately or defer if it was created on other context. | |
void | _dispatchCompute (const Vector3i &workgroupDim) override |
void | _endFrame (void) override |
void | _getDepthStencilFormatFor (PixelFormat internalColourFormat, uint32 *depthFormat, uint32 *stencilFormat) override |
GL3PlusStateCacheManager * | _getStateCacheManager () |
void | _initialise () override |
void | _oneTimeContextInitialization () override |
void | _render (const RenderOperation &op) override |
void | _setAlphaRejectSettings (CompareFunction func, unsigned char value, bool alphaToCoverage) override |
Sets the global alpha rejection approach for future renders. | |
void | _setCullingMode (CullingMode mode) override |
void | _setDepthBias (float constantBias, float slopeScaleBias) override |
void | _setDepthBufferParams (bool depthTest=true, bool depthWrite=true, CompareFunction depthFunction=CMPF_LESS_EQUAL) override |
void | _setDepthClamp (bool enable) override |
void | _setLineWidth (float width) override |
void | _setPolygonMode (PolygonMode level) override |
void | _setRenderTarget (RenderTarget *target) override |
Set current render target to target, enabling its GL context if needed. | |
void | _setSampler (size_t unit, Sampler &sampler) override |
void | _setTexture (size_t unit, bool enabled, const TexturePtr &tex) override |
void | _setViewport (Viewport *vp) override |
void | _switchContext (GL3PlusContext *context) |
Switch GL context, dealing with involved internal cached states too. | |
void | _unregisterContext (GL3PlusContext *context) override |
Unregister a render target->context mapping. | |
void | beginProfileEvent (const String &eventName) override |
This marks the beginning of an event for GPU profiling. | |
void | bindGpuProgram (GpuProgram *prg) override |
void | bindGpuProgramParameters (GpuProgramType gptype, const GpuProgramParametersPtr ¶ms, uint16 mask) override |
void | clearFrameBuffer (unsigned int buffers, const ColourValue &colour=ColourValue::Black, float depth=1.0f, unsigned short stencil=0) override |
HardwareOcclusionQuery * | createHardwareOcclusionQuery (void) override |
MultiRenderTarget * | createMultiRenderTarget (const String &name) override |
Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. | |
RenderSystemCapabilities * | createRenderSystemCapabilities () const override |
void | destroyRenderWindow (const String &name) override |
void | endProfileEvent (void) override |
Ends the currently active GPU profiling event. | |
const String & | getName (void) const override |
void | initConfigOptions () override |
void | initialiseContext (RenderWindow *primary) |
void | initialiseFromRenderSystemCapabilities (RenderSystemCapabilities *caps, RenderTarget *primary) override |
void | markProfileEvent (const String &eventName) override |
Marks an instantaneous event for graphics profilers. | |
void | setColourBlendState (const ColourBlendState &state) override |
void | setScissorTest (bool enabled, const Rect &rect=Rect()) override |
void | setStencilState (const StencilState &state) override |
void | shutdown (void) override |
void | unbindGpuProgram (GpuProgramType gptype) override |
Static Public Member Functions | |
static GLint | convertCompareFunction (CompareFunction func) |
static GLint | convertStencilOp (StencilOperation op, bool invert=false) |
Implementation of GL 3 as a rendering system.
Ogre::GL3PlusRenderSystem::GL3PlusRenderSystem | ( | ) |
Ogre::GL3PlusRenderSystem::~GL3PlusRenderSystem | ( | ) |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
Creates a new rendering window.
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.
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 |
externalWlDisplay | wl_display address as an integer | 0 (none) | Wayland display connection | Linux |
externalWlSurface | wl_surface address as an integer | 0 (none) | Wayland onscreen surface | Linux |
currentGLContext | true, false | false | Use an externally created GL context. (Must be current) | OpenGL |
currentEGLSurface | true, false | false | Use an externally created EGL surface. | Android |
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 |
|
override |
Creates a DepthBuffer that can be attached to the specified RenderTarget.
It doesn't attach anything, it just returns a pointer to a new DepthBuffer Caller is responsible for putting this buffer into the right pool, for attaching, and deleting it. Here's where API-specific magic happens. Don't call this directly unless you know what you're doing.
|
override |
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.
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
References Ogre::CMPF_LESS_EQUAL.
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
References Ogre::ColourValue::Black.
|
override |
|
inline |
|
override |
Create VAO on current context.
|
override |
Bind VAO, context should be equal to current context, as VAOs are not shared.
|
override |
Destroy VAO immediately or defer if it was created on other context.
|
override |
Destroy FBO immediately or defer if it was created on other context.
|
override |
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.
void Ogre::GL3PlusRenderSystem::_switchContext | ( | GL3PlusContext * | context | ) |
Switch GL context, dealing with involved internal cached states too.
|
override |
void Ogre::GL3PlusRenderSystem::initialiseContext | ( | RenderWindow * | primary | ) |
|
override |
Set current render target to target, enabling its GL context if needed.
|
static |
|
static |
|
override |
|
override |
|
override |
|
override |
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 |
|
override |
This marks the beginning of an event for GPU profiling.
|
override |
Ends the currently active GPU profiling event.
|
override |
Marks an instantaneous event for graphics profilers.
This is equivalent to calling
|
override |
Copies the current contents of the render target to a pixelbox.