 |
OGRE-Next
2.3
Object-Oriented Graphics Rendering Engine
|
|
OGRE-Next
2.3
Object-Oriented Graphics Rendering Engine
|
Defines the functionality of a 3D API. More...
#include <OgreRenderSystem.h>
Inheritance diagram for Ogre::RenderSystem:Classes | |
| class | Listener |
| Defines a listener on the custom events that this render system can raise. More... | |
| struct | RenderSystemContext |
Public Member Functions | |
| RenderSystem () | |
| Default Constructor. More... | |
| virtual | ~RenderSystem () |
| Destructor. More... | |
| void | _addMetrics (const RenderingMetrics &newMetrics) |
| virtual void | _beginFrame ()=0 |
| Signifies the beginning of a frame, i.e. More... | |
| 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 | _dispatch (const HlmsComputePso &pso)=0 |
| virtual void | _endFrame ()=0 |
| Ends rendering of a frame to the current viewport. More... | |
| 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 | _hlmsBlendblockCreated (HlmsBlendblock *newBlock) |
| virtual void | _hlmsBlendblockDestroyed (HlmsBlendblock *block) |
| virtual void | _hlmsComputePipelineStateObjectCreated (HlmsComputePso *newPso) |
| virtual void | _hlmsComputePipelineStateObjectDestroyed (HlmsComputePso *newPso) |
| 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) |
| virtual Window * | _initialise (bool autoCreateWindow, const String &windowTitle="OGRE Render Window") |
| Start up the renderer using the settings selected (Or the defaults if none have been selected). More... | |
| 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... | |
| virtual void | _render (const CbDrawCallIndexed *cmd)=0 |
| Renders the VAO. Assumes _setVertexArrayObject has already been called. More... | |
| virtual void | _render (const CbDrawCallStrip *cmd)=0 |
| virtual void | _render (const v1::CbDrawCallIndexed *cmd)=0 |
| Renders a V1 RenderOperation. Assumes _setRenderOperation has already been called. More... | |
| virtual void | _render (const v1::CbDrawCallStrip *cmd)=0 |
| virtual void | _render (const v1::RenderOperation &op) |
| Render something to the active viewport. More... | |
| virtual void | _renderEmulated (const CbDrawCallIndexed *cmd)=0 |
| virtual void | _renderEmulated (const CbDrawCallStrip *cmd)=0 |
| 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) |
| 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 | _setComputePso (const HlmsComputePso *pso)=0 |
| 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... | |
| 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 | _setHlmsSamplerblock (uint8 texUnit, const HlmsSamplerblock *Samplerblock)=0 |
| @See HlmsSamplerblock. More... | |
| virtual void | _setIndirectBuffer (IndirectBufferPacked *indirectBuffer)=0 |
| virtual void | _setPipelineStateObject (const HlmsPso *pso) |
| @See HlmsPso More... | |
| virtual void | _setPointParameters (Real size, bool attenuationEnabled, Real constant, Real linear, Real quadratic, Real minSize, Real maxSize)=0 |
| Sets the size of points and how they are attenuated with distance. More... | |
| virtual void | _setPointSpritesEnabled (bool enabled)=0 |
| Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points. More... | |
| virtual void | _setProjectionMatrix (const Matrix4 &m)=0 |
| Sets the projection transform matrix. More... | |
| virtual void | _setRenderOperation (const v1::CbRenderOp *cmd)=0 |
| virtual void | _setSamplers (uint32 slotStart, const DescriptorSetSampler *set)=0 |
| virtual void | _setSamplersCS (uint32 slotStart, const DescriptorSetSampler *set)=0 |
| virtual void | _setSurfaceParams (const ColourValue &ambient, const ColourValue &diffuse, const ColourValue &specular, const ColourValue &emissive, Real shininess, TrackVertexColourType tracking=TVC_NONE)=0 |
| Sets the surface properties to be used for future rendering. More... | |
| 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 | _setTextureBlendMode (size_t unit, const LayerBlendModeEx &bm)=0 |
| Sets the texture blend modes from a TextureUnitState record. More... | |
| virtual void | _setTextureCoordCalculation (size_t unit, TexCoordCalcMethod m, const Frustum *frustum=0)=0 |
| Sets a method for automatically calculating texture coordinates for a stage. More... | |
| virtual void | _setTextureMatrix (size_t unit, const Matrix4 &xform)=0 |
| 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 | _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 | _setVertexArrayObject (const VertexArrayObject *vao)=0 |
| Part of the low level rendering interface. More... | |
| 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 | _setViewMatrix (const Matrix4 &m)=0 |
| Sets the view transform matrix. More... | |
| virtual void | _setWorldMatrices (const Matrix4 *m, unsigned short count) |
| Sets multiple world matrices (vertex blending). More... | |
| virtual void | _setWorldMatrix (const Matrix4 &m)=0 |
| Sets the world transform matrix. More... | |
| virtual void | _startLegacyV1Rendering () |
| May override the current VertexArrayObject! More... | |
| void | _update () |
| Called once per frame, regardless of how many active workspaces there are. More... | |
| virtual void | _useLights (const LightList &lights, unsigned short limit)=0 |
| 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... | |
| 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 bool | areFixedFunctionLightsInViewSpace () const |
| Are fixed-function lights provided in view space? Affects optimisation. More... | |
| virtual void | beginGPUSampleProfile (const String &name, uint32 *hashCache)=0 |
| virtual void | beginProfileEvent (const String &eventName)=0 |
| This marks the beginning of an event for GPU profiling. 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 | bindGpuProgramParameters (GpuProgramType gptype, GpuProgramParametersSharedPtr params, uint16 variabilityMask)=0 |
| Bind Gpu program parameters. More... | |
| virtual void | bindGpuProgramPassIterationParameters (GpuProgramType gptype)=0 |
| Only binds Gpu program parameters used for passes that have more than one iteration rendering. More... | |
| virtual bool | checkExtension (const String &ext) const |
| Checks for the presense of an API-specific extension (eg. Vulkan, GL) 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 HardwareOcclusionQuery * | createHardwareOcclusionQuery ()=0 |
| Create an object for performing hardware occlusion queries. More... | |
| virtual RenderPassDescriptor * | createRenderPassDescriptor ()=0 |
| virtual RenderSystemCapabilities * | createRenderSystemCapabilities () const =0 |
| Query the real capabilities of the GPU and driver in the RenderSystem. More... | |
| virtual void | debugAnnotationPop () |
| virtual void | debugAnnotationPush (const String &event) |
| Specifically meant to mark passes in RenderDoc. More... | |
| virtual void | deinitGPUProfiling ()=0 |
| 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) |
| See RenderSystem::startGpuDebuggerFrameCapture Call this function when you're done capturing a frame. More... | |
| virtual void | endGPUSampleProfile (const String &name)=0 |
| virtual void | endProfileEvent ()=0 |
| Ends the currently active GPU profiling event. 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 |
| BarrierSolver & | getBarrierSolver () |
| BoundUav | getBoundUav (size_t slot) const |
| const RenderSystemCapabilities * | getCapabilities () const |
| Gets the capabilities of the render system. More... | |
| virtual VertexElementType | getColourVertexElementType () const =0 |
| Get the native VertexElementType for a compact 32-bit colour value for this rendersystem. More... | |
| virtual ConfigOptionMap & | getConfigOptions ()=0 |
| Returns the details of this API's configuration options. More... | |
| RenderPassDescriptor * | getCurrentPassDescriptor () |
| Viewport * | getCurrentRenderViewports () |
| virtual void | getCustomAttribute (const String &name, void *pData) |
| Gets a custom (maybe platform-specific) attribute. More... | |
| bool | getDebugShaders () const |
| virtual TextureGpu * | getDepthBufferFor (TextureGpu *colourTexture, uint16 poolId, bool preferDepthTexture, PixelFormatGpu depthBufferFormat) |
| virtual unsigned int | getDisplayMonitorCount () const =0 |
| Gets the number of display monitors. More... | |
| virtual const DriverVersion & | getDriverVersion () const |
| Returns the driver version. More... | |
| virtual String | getErrorDescription (long errorNumber) const =0 |
| Returns a description of an error code. More... | |
| virtual const String & | getFriendlyName () const =0 |
| Returns the friendly name of the render system. More... | |
| v1::HardwareVertexBufferSharedPtr | getGlobalInstanceVertexBuffer () const |
| Returns the global instance vertex buffer. More... | |
| v1::VertexDeclaration * | getGlobalInstanceVertexBufferVertexDeclaration () const |
| Gets vertex declaration for the global vertex buffer for the global instancing. More... | |
| size_t | getGlobalNumberOfInstances () const |
| Gets the global number of instances. More... | |
| virtual Real | getHorizontalTexelOffset ()=0 |
| Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. 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 () |
| virtual Real | getMaximumDepthInputValue ()=0 |
| Gets the maximum (farthest) depth value to be used when rendering using identity transforms. More... | |
| const RenderingMetrics & | getMetrics () const |
| virtual Real | getMinimumDepthInputValue ()=0 |
| Gets the minimum (closest) depth value to be used when rendering using identity transforms. More... | |
| RenderSystemCapabilities * | getMutableCapabilities () |
| Get a pointer to the current capabilities being used by the RenderSystem. More... | |
| virtual const String & | getName () const =0 |
| Returns the name of the rendering system. 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 PixelFormatToShaderType * | getPixelFormatToShaderType () const =0 |
| 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 StringVector & | getRenderSystemEvents () 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 StencilParams & | getStencilBufferParams () const |
| TextureGpuManager * | getTextureGpuManager () const |
| VaoManager * | getVaoManager () const |
| virtual Real | getVerticalTexelOffset ()=0 |
| Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem. More... | |
| bool | getWBufferEnabled () const |
| Returns true if the renderer will try to use W-buffers when available. More... | |
| virtual bool | hasAnisotropicMipMapFilter () const =0 |
| Determines if the system has anisotropic mip map filter support. More... | |
| virtual void | initGPUProfiling ()=0 |
| 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... | |
| virtual void | markProfileEvent (const String &event)=0 |
| Marks an instantaneous event for graphics profilers. More... | |
| void | operator delete (void *ptr) |
| void | operator delete (void *ptr, const char *, int, const char *) |
| void | operator delete (void *ptr, void *) |
| void | operator delete[] (void *ptr) |
| void | operator delete[] (void *ptr, const char *, int, const char *) |
| void * | operator new (size_t sz) |
| void * | operator new (size_t sz, const char *file, int line, const char *func) |
| operator new, with debug line info More... | |
| void * | operator new (size_t sz, void *ptr) |
| placement operator new More... | |
| void * | operator new[] (size_t sz) |
| void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
| array operator new, with debug line info More... | |
| virtual void | postExtraThreadsStarted ()=0 |
| virtual void | preExtraThreadsStarted ()=0 |
| 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 | queueBindUAVs (const DescriptorSetUav *descSetUav) |
| Queues the binding of an UAV to the binding point/slot. More... | |
| virtual void | registerThread ()=0 |
| Register the an additional thread which may make calls to rendersystem-related objects. More... | |
| virtual void | reinitialise ()=0 |
| Restart the renderer (normally following a change in settings). 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 | setConfigOption (const String &name, const String &value)=0 |
| Sets an option for this API. 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) |
| virtual void | setStencilBufferParams (uint32 refValue, const StencilParams &stencilParams) |
| This method allows you to set all the stencil buffer parameters in one call. More... | |
| 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 void | shutdown () |
| Shutdown the renderer and cleanup resources. 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 void | unregisterThread ()=0 |
| Unregister an additional thread which may make calls to rendersystem-related objects. 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 String | validateConfigOptions ()=0 |
| Validates the options set for the rendering system, returning a message if there are problems. 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... | |
Static Public Member Functions | |
| 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... | |
Defines the functionality of a 3D API.
| Ogre::RenderSystem::RenderSystem | ( | ) |
Default Constructor.
|
virtual |
Destructor.
| void Ogre::RenderSystem::_addMetrics | ( | const RenderingMetrics & | newMetrics | ) |
|
pure virtual |
Signifies the beginning of a frame, i.e.
the start of rendering on a single viewport. Will occur several times per complete frame if multiple viewports exist.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Signifies the beginning of the main frame.
i.e. will only be called once per frame, not per viewport
Reimplemented in Ogre::MetalRenderSystem.
| void Ogre::RenderSystem::_cleanupDepthBuffers | ( | ) |
|
virtual |
On D3D11 calls ClearState followed by Flush().
On GL3+ it calls glFlush
Do not call this function while inside rendering internals, as it will clear the device state, thus leaving it inconsistent with what we think it is set to.
Reimplemented in Ogre::D3D11RenderSystem.
|
virtual |
Converts an OpenVR projection matrix to have the proper depth range and reverse Z settings.
| matrix | |
| dest |
Reimplemented in Ogre::GL3PlusRenderSystem.
|
virtual |
Converts a uniform projection matrix to suitable for this render system.
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::NULLRenderSystem.
|
pure virtual |
Creates a new rendering window.
| name | The name of the window. Used in other methods later like setRenderTarget and getRenderTarget. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| width | The width of the new window. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| height | The height of the new window. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fullScreen | Specify true to make the window full screen without borders, title bar or menu bar. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| miscParams | A NameValuePairList describing the other parameters for the new rendering window. Options are case sensitive. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platforms unless indicated otherwise:
|
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::NULLRenderSystem.
|
virtual |
Creates multiple rendering windows.
| renderWindowDescriptions | Array of structures containing the descriptions of each render window. The structure's members are the same as the parameters of _createRenderWindow: name width height fullScreen miscParams See _createRenderWindow for details about each member. |
| createdWindows | This array will hold the created render windows. |
Reimplemented in Ogre::GL3PlusRenderSystem.
| void Ogre::RenderSystem::_dereferenceSharedDepthBuffer | ( | TextureGpu * | depthBuffer | ) |
Releases the reference count on a shared depth buffer.
Does nothing if input is not a shared depth buffer.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, and Ogre::D3D11RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, and Ogre::D3D11RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
pure virtual |
|
pure virtual |
Ends rendering of a frame to the current viewport.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Called once per frame, regardless of how many active workspaces there are.
Gets called AFTER all RenderWindows have been swapped.
Reimplemented in Ogre::VulkanRenderSystem, and Ogre::MetalRenderSystem.
|
inline |
|
virtual |
Returns the default material scheme used by the render system.
Systems that use the RTSS to emulate a fixed function pipeline (e.g. OpenGL ES 2, GL3+, DX11) need to override this function to return the default material scheme of the RTSS ShaderGenerator.
This is currently only used to set the default material scheme for viewports. It is a necessary step on these render systems for render textures to be rendered into properly.
Referenced by Ogre::CompositorPassSceneDef::CompositorPassSceneDef().
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::MetalRenderSystem, Ogre::VulkanRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, and Ogre::VulkanRenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Start up the renderer using the settings selected (Or the defaults if none have been selected).
| autoCreateWindow | If true, creates a render window automatically, based on settings chosen so far. This saves an extra call to _createRenderWindow for the main render window. |
| windowTitle | Sets the app window title |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
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].
_convertProjectionMatrix does the same thing but is more generic. This version assumes a standard projection matrix (i.e. not oblique) to maximize precision
| matrix | |
| dest | |
| nearPlane | |
| farPlane | |
| projectionType |
Reimplemented in Ogre::GL3PlusRenderSystem.
|
virtual |
Pause rendering for a frame.
This has to be called after _beginFrame and before _endFrame. Will usually be called by the SceneManager, don't use this manually unless you know what you are doing.
|
pure virtual |
Renders the VAO. Assumes _setVertexArrayObject has already been called.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
|
pure virtual |
Renders a V1 RenderOperation. Assumes _setRenderOperation has already been called.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
|
virtual |
Render something to the active viewport.
Low-level rendering interface to perform rendering operations. Unlikely to be used directly by client applications, since the SceneManager and various support classes will be responsible for calling this method. Can only be called between _beginScene and _endScene
| op | A rendering operation instance, which contains details of the operation to be performed. |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
|
pure virtual |
|
inlinevirtual |
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
| void Ogre::RenderSystem::_resetMetrics | ( | ) |
|
virtual |
Resume rendering for a frame.
This has to be called after a _pauseFrame call Will usually be called by the SceneManager, don't use this manually unless you know what you are doing.
| context | the render system context, as returned by _pauseFrame |
|
virtual |
Set texture unit binding type.
Reimplemented in Ogre::D3D11RenderSystem.
|
pure 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)
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
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.
| texture | Cannot be null. |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::NULLRenderSystem.
|
virtual |
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
pure virtual |
@See HlmsSamplerblock.
This function MUST be called after _setTexture, not before. Otherwise not all APIs may see the change.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
|
virtual |
@See HlmsPso
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets the size of points and how they are attenuated with distance.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points.
| enabled | True enables point sprites, false returns to normal point rendering. |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets the projection transform matrix.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
Sets the surface properties to be used for future rendering.
This method sets the the properties of the surfaces of objects to be rendered after it. In this context these surface properties are the amount of each type of light the object reflects (determining it's colour under different types of light), whether it emits light itself, and how shiny it is. Textures are not dealt with here, see the _setTetxure method for details. This method is used by _setMaterial so does not need to be called direct if that method is being used.
| ambient | The amount of ambient (sourceless and directionless) light an object reflects. Affected by the colour/amount of ambient light in the scene. |
| diffuse | The amount of light from directed sources that is reflected (affected by colour/amount of point, directed and spot light sources) |
| specular | The amount of specular light reflected. This is also affected by directed light sources but represents the colour at the highlights of the object. |
| emissive | The colour of light emitted from the object. Note that this will make an object seem brighter and not dependent on lights in the scene, but it will not act as a light, so will not illuminate other objects. Use a light attached to the same SceneNode as the object for this purpose. |
| shininess | A value which only has an effect on specular highlights (so specular must be non-black). The higher this value, the smaller and crisper the specular highlights will be, imitating a more highly polished surface. This value is not constrained to 0.0-1.0, in fact it is likely to be more (10.0 gives a modest sheen to an object). |
| tracking | A bit field that describes which of the ambient, diffuse, specular and emissive colours follow the vertex colour of the primitive. When a bit in this field is set its ColourValue is ignored. This is a combination of TVC_AMBIENT, TVC_DIFFUSE, TVC_SPECULAR(note that the shininess value is still taken from shininess) and TVC_EMISSIVE. TVC_NONE means that there will be no material property tracking the vertex colours. |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::NULLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
virtual |
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
pure virtual |
Sets the texture to bind to a given texture unit.
User processes would not normally call this direct unless rendering primitives themselves.
| unit | The index of the texture unit to modify. Multitexturing hardware can support multiple units (see RenderSystemCapabilites::getNumTextureUnits) |
| enabled | Boolean to turn the unit on/off |
| texPtr | Pointer to the texture to use. |
| bDepthReadOnly | true if the texture is also attached as a depth buffer but is read only |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GL3PlusRenderSystem.
|
pure virtual |
Sets the texture blend modes from a TextureUnitState record.
Meant for use internally only - apps should use the Material and TextureUnitState classes.
| unit | Texture unit as above |
| bm | Details of the blending mode |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets a method for automatically calculating texture coordinates for a stage.
Should not be used by apps - for use by Ogre only.
| unit | Texture unit as above |
| m | Calculation method to use |
| frustum | Optional Frustum param, only used for projective effects |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Sets the texture coordinate transformation matrix for a texture unit.
| unit | Texture unit to affect |
| xform | The 4x4 matrix |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Notify the rendersystem that it should adjust texture projection to be relative to a different origin.
|
pure virtual |
| slotStart | |
| set | |
| hazardousTexIdx | When hazardousTexIdx < set->mTextures.size(); it means that we need to check if set->mTextures[hazardousTexIdx] is not the same as the currently bound RTT. |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::NULLRenderSystem.
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
virtual |
Utility function for setting all the properties of a texture unit at once.
This method is also worth using over the individual texture unit settings because it only sets those settings which are different from the current settings for this unit, thus minimising render state changes.
|
pure virtual |
|
pure 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.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Binds a texture to a vertex, geometry, compute, tessellation hull or tessellation domain sampler.
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
pure virtual |
Sets the view transform matrix.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Sets multiple world matrices (vertex blending).
|
pure virtual |
Sets the world transform matrix.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
May override the current VertexArrayObject!
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
| void Ogre::RenderSystem::_update | ( | ) |
Called once per frame, regardless of how many active workspaces there are.
|
pure virtual |
Tells the rendersystem to use the attached set of lights (and no others) up to the number specified (this allows the same list to be used with different count limits)
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, Ogre::GLES2RenderSystem, and Ogre::GL3PlusRenderSystem.
|
virtual |
Add a user clipping plane.
Add a user clipping plane.
|
virtual |
Adds a listener to the custom events that this render system can raise.
|
static |
Sets shared listener.
|
inlinevirtual |
Are fixed-function lights provided in view space? Affects optimisation.
Reimplemented in Ogre::GL3PlusRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
This marks the beginning of an event for GPU profiling.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
When the descriptor is set to Load clear, two possible things may happen:
| desc | |
| anyTarget | Contains the first valid texture in mRenderPassDesc, to be used for reference (e.g. width, height, etc). Could be colour, depth, stencil, or nullptr. |
| mipLevel | Mip at which anyTarget is bound |
| viewportSize | |
| warnIfRtvWasFlushed | See CompositorPassDef::mWarnIfRtvWasFlushed |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
pure virtual |
Bind Gpu program parameters.
| gptype | The type of program to bind the parameters to |
| params | The parameters to bind |
| variabilityMask | A mask of GpuParamVariability identifying which params need binding |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::NULLRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Only binds Gpu program parameters used for passes that have more than one iteration rendering.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Checks for the presense of an API-specific extension (eg. Vulkan, GL)
Reimplemented in Ogre::GLES2RenderSystem.
|
pure virtual |
Immediately clears the whole frame buffer on the selected RenderPassDescriptor.
Prefer clearing using the LoadAction semantics in the RenderPassDescriptor. This function is provided for two reasons:
| renderPassDesc | RenderPassDescriptor filled with LoadActions set to clear and StoreActions set to Store. |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::NULLRenderSystem.
|
virtual |
See RenderSystem::updateCompositorManager.
Reimplemented in Ogre::MetalRenderSystem.
|
virtual |
See RenderSystem::updateCompositorManager.
Reimplemented in Ogre::MetalRenderSystem.
|
virtual |
See RenderSystem::updateCompositorManager.
Reimplemented in Ogre::MetalRenderSystem.
|
virtual |
Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem.
| colour | The colour to convert |
| pDest | Pointer to location to put the result. |
|
pure virtual |
Create an object for performing hardware occlusion queries.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
|
pure virtual |
Query the real capabilities of the GPU and driver in the RenderSystem.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
inlinevirtual |
Specifically meant to mark passes in RenderDoc.
See https://renderdoc.org/docs/how/how_annotate_capture.html
In many cases it will use the same interface as beginProfileEvent / endProfileEvent
Note: For security & performance reasons this feature is only enabled when OGRE_DEBUG_MODE >= OGRE_DEBUG_MEDIUM
Reimplemented in Ogre::VulkanRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
pure virtual |
|
virtual |
Destroy a hardware occlusion query object.
| void Ogre::RenderSystem::destroyRenderPassDescriptor | ( | RenderPassDescriptor * | renderPassDesc | ) |
|
virtual |
Destroys a render window.
|
inlinevirtual |
Required when caller will soon start analyzing barriers (e.g.
use BarrierSolver) Ogre will flush any pending resource transitions.
Otherwise BarrierSolver will see that a Resource is in a particular state or layout, then when calling executeResourceTransition, the pending resource layout will be flushed, and now the resource transition resolved by BarrierSolver will have the wrong 'old' layout
Reimplemented in Ogre::VulkanRenderSystem.
|
virtual |
See RenderSystem::startGpuDebuggerFrameCapture Call this function when you're done capturing a frame.
|
pure virtual |
|
pure virtual |
Ends the currently active GPU profiling event.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
virtual |
Metal needs to delay RenderCommand creation to the last minute, because we can't issue blit operations (e.g.
buffer copies) which a lot of v1 code relies on otherwise the RenderCommand gets canceled. Even if we were to get rid of v1 operations, the user may want to hook listeners for _renderPhase02 and perform forbidden operations. Therefore it's easier to split the process done in beginRenderPassDescriptor in two steps (beginRenderPassDescriptor and executeRenderPassDescriptorDelayedActions) for Metal.
Reimplemented in Ogre::VulkanRenderSystem, and Ogre::MetalRenderSystem.
|
inlinevirtual |
Reimplemented in Ogre::VulkanRenderSystem, and Ogre::GL3PlusRenderSystem.
|
static |
|
pure virtual |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::D3D11RenderSystem, and Ogre::NULLRenderSystem.
|
inline |
| BoundUav Ogre::RenderSystem::getBoundUav | ( | size_t | slot | ) | const |
|
inline |
Gets the capabilities of the render system.
|
pure virtual |
Get the native VertexElementType for a compact 32-bit colour value for this rendersystem.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Returns the details of this API's configuration options.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
inline |
|
inline |
|
virtual |
Gets a custom (maybe platform-specific) attribute.
| name | The name of the attribute. |
| pData | Pointer to memory of the right kind of structure to receive the info. |
Reimplemented in Ogre::D3D11RenderSystem.
|
inline |
|
virtual |
|
pure virtual |
Gets the number of display monitors.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
Returns the driver version.
|
pure virtual |
Returns a description of an error code.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Returns the friendly name of the render system.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
| v1::HardwareVertexBufferSharedPtr Ogre::RenderSystem::getGlobalInstanceVertexBuffer | ( | ) | const |
Returns the global instance vertex buffer.
| v1::VertexDeclaration* Ogre::RenderSystem::getGlobalInstanceVertexBufferVertexDeclaration | ( | ) | const |
Gets vertex declaration for the global vertex buffer for the global instancing.
| size_t Ogre::RenderSystem::getGlobalNumberOfInstances | ( | ) | const |
Gets the global number of instances.
|
pure virtual |
Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
inline |
+Y is downwards in NDC (Normalized Device Coordinates). Only Vulkan has this problem.
|
virtual |
Indicates whether or not the vertex windings set will be inverted for the current render (e.g.
reflections)
|
inline |
|
pure virtual |
Gets the maximum (farthest) depth value to be used when rendering using identity transforms.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
| const RenderingMetrics& Ogre::RenderSystem::getMetrics | ( | ) | const |
|
pure virtual |
Gets the minimum (closest) depth value to be used when rendering using identity transforms.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
inline |
Get a pointer to the current capabilities being used by the RenderSystem.
|
pure virtual |
Returns the name of the rendering system.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
inline |
Gets the native shading language version for this render system.
Formatted so that it can be used within a shading program. For example, OpenGL 3.2 would return 150, while 3.3 would return 330
|
virtual |
Number of priority config options in RenderSystem::getPriorityConfigOption.
Therefore a proper loop would call getNumPriorityConfigOptions on every iteration:
Reimplemented in Ogre::VulkanRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
pure virtual |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::D3D11RenderSystem, and Ogre::NULLRenderSystem.
|
virtual |
Some options depend on other options.
Therefore it's best to call RenderSystem::setConfigOption in order
| idx | Value must be in range [0; getNumPriorityConfigOptions) |
Options must be set in ascending order, i.e. idx = 0 must be called before idx = 1
Reimplemented in Ogre::VulkanRenderSystem, Ogre::GL3PlusRenderSystem, and Ogre::D3D11RenderSystem.
|
inline |
Returns the RenderDoc API handle in case you want to do more advanced functionality than what we expose.
Note we may return nullptr if RenderDoc was not yet loaded.
Call RenderSystem::loadRenderDocApi first if you wish the returned ptr to not be null (it may still be null if we fail to load RenderDoc)
|
inlinevirtual |
Gets a list of the rendersystem specific events that this rendersystem can raise.
|
inlinevirtual |
OpenGL depth is in range [-1;1] so it returns 2.0f; D3D11 & Metal are in range [0;1] so it returns 1.0f;.
Note OpenGL may behave like D3D11, and thus we'll return 1.0f too. This is decided at runtime, not at compile time.
Reimplemented in Ogre::GL3PlusRenderSystem.
|
inline |
|
inline |
|
inline |
|
pure virtual |
Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
| bool Ogre::RenderSystem::getWBufferEnabled | ( | ) | const |
Returns true if the renderer will try to use W-buffers when available.
|
pure virtual |
Determines if the system has anisotropic mip map filter support.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
|
virtual |
Returns whether or not a Gpu program of the given type is currently bound.
|
inline |
|
virtual |
Returns true if 'a' and 'b' internally map to the same layout and should be considered equivalent for a given texture.
| bIsDebugCheck | When true, we're calling this as a consistency check (e.g. asserts if layouts changed externally outside the BarrierSolver). Non-explicit APIs may return too many false negatives triggering the assert, thus this flag prevents false crashes |
Reimplemented in Ogre::VulkanRenderSystem.
|
inlinevirtual |
| bool Ogre::RenderSystem::loadRenderDocApi | ( | ) |
Explicitly loads RenderDoc.
It is not necessary to call this function unless you want to use RenderSystem::getRenderDocApi before we are required to load RenderDoc.
|
pure virtual |
Marks an instantaneous event for graphics profilers.
This is equivalent to calling
Implemented in Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::GLES2RenderSystem, Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, and Ogre::NULLRenderSystem.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
|
inlineinherited |
placement operator new
|
inlineinherited |
|
inlineinherited |
array operator new, with debug line info
|
pure virtual |
|
pure virtual |
Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
| void Ogre::RenderSystem::queueBindUAVs | ( | const DescriptorSetUav * | descSetUav | ) |
Queues the binding of an UAV to the binding point/slot.
It won't actually take effect until you flush the UAVs or set another RTT.
OpenGL however, does not make this distinction. Hence once we switch back to 3D rendering, we need to restore UAVs set via queueBindUAV.
|
pure virtual |
Register the an additional thread which may make calls to rendersystem-related objects.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
pure virtual |
Restart the renderer (normally following a change in settings).
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Remove a listener to the custom events that this render system can raise.
|
static |
Remove shared listener to the custom events that this render system can raise.
|
virtual |
Clears the user clipping region.
|
static |
Reverts the compare order e.g.
greater_equal becomes less_equal Used by reverse depth
| depthFunc |
|
virtual |
Sets the user clipping region.
|
pure virtual |
Sets an option for this API.
| name | The name of the option to alter. |
| value | The value to set the option to. |
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
set the current multi pass count value.
This must be set prior to calling _render() if multiple renderings of the same pass state are required.
| count | Number of times to render the current state. |
| void Ogre::RenderSystem::setDebugShaders | ( | bool | bDebugShaders | ) |
Instructs the RenderSystem to compile shaders without optimizations and with debug information, for easier debugging on APIs that support it.
Default is true if OGRE_DEBUG_MODE >= OGRE_DEBUG_HIGH, else false
This setting takes effect for shaders compiled afterwards. Already compiled shaders won't change unless you manually rebuild them.
It is highly recommended you disable the Microcode cache before changing the default, or else debug shaders may contaminate your cache, or alternatively a shader from the cache may be used which may have been compiled with a different setting.
|
inlinevirtual |
Tell the render system whether to derive a depth bias on its own based on the values passed to it in setCurrentPassIterationCount.
The depth bias set will be baseValue + iteration * multiplier
| derive | True to tell the RS to derive this automatically |
| baseValue | The base value to which the multiplier should be added |
| multiplier | The amount of depth bias to apply per iteration |
| slopeScale | The constant slope scale bias for completeness |
|
inlinevirtual |
Sets the colour buffer that the render system will to draw.
If the render system implementation or configuration does not support a particular value, then false will be returned and the current colour buffer value will not be modified.
| colourBuffer | Specifies the colour buffer that will be drawn into. |
Reimplemented in Ogre::D3D11RenderSystem.
| void Ogre::RenderSystem::setGlobalInstanceVertexBuffer | ( | const v1::HardwareVertexBufferSharedPtr & | val | ) |
Sets the global instance vertex buffer.
| void Ogre::RenderSystem::setGlobalInstanceVertexBufferVertexDeclaration | ( | v1::VertexDeclaration * | val | ) |
Sets vertex declaration for the global vertex buffer for the global instancing.
| void Ogre::RenderSystem::setGlobalNumberOfInstances | ( | const size_t | val | ) |
Sets the global number of instances.
| void Ogre::RenderSystem::setInvertVertexWinding | ( | bool | invert | ) |
Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections.
| void Ogre::RenderSystem::setMetricsRecordingEnabled | ( | bool | bEnable | ) |
|
virtual |
This method allows you to set all the stencil buffer parameters in one call.
(Reference Value & Mask) CompareFunction (Stencil Buffer Value & Mask)The result of this will cause one of 3 actions depending on whether the test fails, succeeds but with the depth buffer check still failing, or succeeds with the depth buffer check passing too.
| refValue | The reference value used in the comparison (dynamic) |
| stencilParams | The static parameters that involve more expensive state changes. Ogre dev implementors note: Should check if the stencilParams are different from before |
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, and Ogre::GLES2RenderSystem.
| void Ogre::RenderSystem::setUavStartingSlot | ( | uint32 | startingSlot | ) |
In Direct3D11, UAV & RenderTargets share the same slots.
Because of this, we enforce the same behavior on all RenderSystems. An unfortunate consequence is that if you attach an MRT consisting of 3 RTs; the UAV needs to set at slot 3; not slot 0. This setting lets you tell Ogre the starting slot; so queueBindUAVs( descSet ) goes from slot 3 onwards if you call setUavStartingSlot( 3 )
| startingSlot | Default value: 1. |
| void Ogre::RenderSystem::setWBufferEnabled | ( | bool | enabled | ) |
Sets whether or not W-buffers are enabled if they are available for this renderer.
| enabled | If true and the renderer supports them W-buffers will be used. If false W-buffers will not be used even if available. W-buffers are enabled by default for 16bit depth buffers and disabled for all other depths. |
|
virtual |
Shutdown the renderer and cleanup resources.
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
Programmatically performs a GPU capture when attached to a GPU debugger like RenderDoc or Metal Graphics Debugger.
You must call RenderSystem::endGpuDebuggerFrameCapture
| window | Can be NULL for automatic capture. |
See pRENDERDOC_StartFrameCapture's documentation
True if we believe the frame capture started. Note a capture may still fail regardless due to other more technical reasons, as rendering APIs are complex.
|
pure virtual |
Unregister an additional thread which may make calls to rendersystem-related objects.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
virtual |
This gives the renderer a chance to perform the compositor update in a special way.
When the render system is ready to perform the actual update it should just compositorManager->_updateImplementation.
Reimplemented in Ogre::MetalRenderSystem.
|
virtual |
Force the render system to use the special capabilities.
Can only be called before the render system has been fully initializer (before createWindow is called)
| capabilities | has to be a subset of the real capabilities and the caller is responsible for deallocating capabilities. |
|
pure virtual |
Validates the options set for the rendering system, returning a message if there are problems.
Implemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, Ogre::GL3PlusRenderSystem, Ogre::D3D11RenderSystem, Ogre::NULLRenderSystem, and Ogre::GLES2RenderSystem.
|
inlinevirtual |
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.
Reimplemented in Ogre::D3D11RenderSystem.
|
virtual |
Returns supported sample description for requested FSAA mode, with graceful downgrading.
Reimplemented in Ogre::VulkanRenderSystem, Ogre::MetalRenderSystem, and Ogre::D3D11RenderSystem.
1.9.1