Implementation of GL 3 as a rendering system. More...

#include <OgreGL3PlusRenderSystem.h>

Inheritance diagram for Ogre::GL3PlusRenderSystem:

Public Member Functions
	GL3PlusRenderSystem ()

	~GL3PlusRenderSystem ()

void	_addMetrics (const Metrics &newMetrics)

void	_beginFrame (void)
	See RenderSystem. More...

virtual void	_beginFrameOnce (void)
	Signifies the beginning of the main frame. More...

void	_cleanupDepthBuffers (void)

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)
	See RenderSystem. More...

Window *	_createRenderWindow (const String &name, uint32 width, uint32 height, bool fullScreen, const NameValuePairList *miscParams=0)
	Creates a new rendering window. More...

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)

void	_endFrame (void)
	See RenderSystem. More...

virtual void	_endFrameOnce (void)
	Called once per frame, regardless of how many active workspaces there are. More...

virtual void	_executeResourceTransition (ResourceTransition *resTransition)

Viewport &	_getCurrentRenderViewport (void)

virtual const String &	_getDefaultViewportMaterialScheme (void) const
	Returns the default material scheme used by the render system. More...

virtual GL3PlusFrameBufferDescMap &	_getFrameBufferDescMap (void)

GL3PlusContext *	_getMainContext ()
	Returns the main context. 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)

Window *	_initialise (bool autoCreateWindow, const String &windowTitle="OGRE Render Window")
	See RenderSystem. 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...

void	_oneTimeContextInitialization ()
	One time initialization for the RenderState of a context. More...

virtual RenderSystemContext *	_pauseFrame (void)
	Pause rendering for a frame. More...

void	_render (const v1::RenderOperation &op)
	See RenderSystem. More...

virtual void	_render (const CbDrawCallIndexed *cmd)
	Renders the VAO. Assumes _setVertexArrayObject has already been called. More...

virtual void	_render (const CbDrawCallStrip *cmd)

virtual void	_render (const v1::CbDrawCallIndexed *cmd)
	Renders a V1 RenderOperation. Assumes _setRenderOperation has already been called. More...

virtual void	_render (const v1::CbDrawCallStrip *cmd)

virtual void	_renderEmulated (const CbDrawCallIndexed *cmd)

virtual void	_renderEmulated (const CbDrawCallStrip *cmd)

virtual void	_renderEmulatedNoBaseInstance (const CbDrawCallIndexed *cmd)

virtual void	_renderEmulatedNoBaseInstance (const CbDrawCallStrip *cmd)

virtual void	_renderNoBaseInstance (const v1::CbDrawCallIndexed *cmd)

virtual void	_renderNoBaseInstance (const v1::CbDrawCallStrip *cmd)

void	_resetMetrics ()

virtual void	_resourceTransitionCreated (ResourceTransition *resTransition)

virtual void	_resourceTransitionDestroyed (ResourceTransition *resTransition)

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)
	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)
	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...

void	_setDepthBias (float constantBias, float slopeScaleBias)
	See RenderSystem. More...

void	_setGeometryTexture (size_t unit, TextureGpu *tex)
	See RenderSystem. More...

void	_setHlmsBlendblock (const HlmsBlendblock blendblock, const GL3PlusHlmsPso pso)

void	_setHlmsMacroblock (const HlmsMacroblock macroblock, const GL3PlusHlmsPso pso)

virtual void	_setHlmsSamplerblock (uint8 texUnit, const HlmsSamplerblock *samplerblock)
	HlmsSamplerblock. More...

virtual void	_setIndirectBuffer (IndirectBufferPacked *indirectBuffer)

virtual void	_setPipelineStateObject (const HlmsPso *pso)
	HlmsPso More...

void	_setPointParameters (Real size, bool attenuationEnabled, Real constant, Real linear, Real quadratic, Real minSize, Real maxSize)
	See RenderSystem. More...

void	_setPointSpritesEnabled (bool enabled)
	See RenderSystem. More...

void	_setProjectionMatrix (const Matrix4 &m)
	See RenderSystem. More...

virtual void	_setRenderOperation (const v1::CbRenderOp *cmd)

virtual void	_setSamplers (uint32 slotStart, const DescriptorSetSampler *set)

virtual void	_setSamplersCS (uint32 slotStart, const DescriptorSetSampler *set)

void	_setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendOperation op)

void	_setSceneBlendingOperation (SceneBlendOperation op)

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

void	_setSeparateSceneBlendingOperation (SceneBlendOperation op, SceneBlendOperation alphaOp)

void	_setSurfaceParams (const ColourValue &ambient, const ColourValue &diffuse, const ColourValue &specular, const ColourValue &emissive, Real shininess, TrackVertexColourType tracking)
	See RenderSystem. More...

void	_setTessellationDomainTexture (size_t unit, TextureGpu *tex)
	See RenderSystem. More...

void	_setTessellationHullTexture (size_t unit, TextureGpu *tex)
	See RenderSystem. More...

void	_setTexture (size_t unit, TextureGpu *tex)
	See RenderSystem. More...

void	_setTextureBlendMode (size_t stage, const LayerBlendModeEx &bm)
	See RenderSystem. More...

void	_setTextureCoordCalculation (size_t stage, TexCoordCalcMethod m, const Frustum *frustum=0)
	See RenderSystem. More...

void	_setTextureMatrix (size_t stage, const Matrix4 &xform)
	See RenderSystem. 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)
	See RenderSystem. More...

virtual void	_setTextures (uint32 slotStart, const DescriptorSetTexture2 *set)

virtual void	_setTexturesCS (uint32 slotStart, const DescriptorSetTexture *set)

virtual void	_setTexturesCS (uint32 slotStart, const DescriptorSetTexture2 *set)

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)

virtual void	_setVertexArrayObject (const VertexArrayObject *vao)
	Part of the low level rendering interface. More...

void	_setVertexTexture (size_t unit, TextureGpu *tex)
	See RenderSystem. More...

void	_setViewMatrix (const Matrix4 &m)
	See RenderSystem. More...

virtual void	_setWorldMatrices (const Matrix4 *m, unsigned short count)
	Sets multiple world matrices (vertex blending). More...

void	_setWorldMatrix (const Matrix4 &m)
	See RenderSystem. More...

virtual void	_startLegacyV1Rendering (void)
	May override the current VertexArrayObject! More...

void	_switchContext (GL3PlusContext *context)
	Switch GL context, dealing with involved internal cached states too. More...

void	_unregisterContext (GL3PlusContext *context)
	Unregister a render target->context mapping. More...

void	_update (void)
	Called once per frame, regardless of how many active workspaces there are. More...

void	_useLights (const LightList &lights, unsigned short limit)
	See RenderSystem. 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...

bool	areFixedFunctionLightsInViewSpace () const
	See RenderSystem. More...

virtual void	beginGPUSampleProfile (const String &name, uint32 *hashCache)

virtual void	beginProfileEvent (const String &eventName)
	This marks the beginning of an event for GPU profiling. More...

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...

void	bindGpuProgramParameters (GpuProgramType gptype, GpuProgramParametersSharedPtr params, uint16 mask)
	Bind Gpu program parameters. More...

void	bindGpuProgramPassIterationParameters (GpuProgramType gptype)
	Only binds Gpu program parameters used for passes that have more than one iteration rendering. More...

virtual void	clearFrameBuffer (RenderPassDescriptor renderPassDesc, TextureGpu anyTarget, uint8 mipLevel)
	Immediately clears the whole frame buffer on the selected RenderPassDescriptor. 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...

GLint	convertCompareFunction (CompareFunction func) const

GLint	convertStencilOp (StencilOperation op) const

TextureGpu *	createDepthBufferFor (TextureGpu *colourTexture, bool preferDepthTexture, PixelFormatGpu depthBufferFormat, uint16 poolId)

HardwareOcclusionQuery *	createHardwareOcclusionQuery (void)
	Create an object for performing hardware occlusion queries. More...

virtual RenderPassDescriptor *	createRenderPassDescriptor (void)

virtual RenderSystemCapabilities *	createRenderSystemCapabilities () const
	See RenderSystem. More...

virtual void	deinitGPUProfiling (void)

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...

void	enableClipPlane (ushort index, bool enable)
	See RenderSystem. More...

virtual void	endGPUSampleProfile (const String &name)

virtual void	endProfileEvent (void)
	Ends the currently active GPU profiling event. More...

virtual void	endRenderPassDescriptor (void)

virtual void	executeRenderPassDescriptorDelayedActions (void)
	Metal needs to delay RenderCommand creation to the last minute, because we can't issue blit operations (e.g. More...

virtual void	flushUAVs (void)
	Forces to take effect all the queued UAV binding requests. More...

const RenderSystemCapabilities *	getCapabilities (void) const
	Gets the capabilities of the render system. More...

VertexElementType	getColourVertexElementType (void) const
	See RenderSystem. More...

ConfigOptionMap &	getConfigOptions (void)
	See RenderSystem. More...

RenderPassDescriptor *	getCurrentPassDescriptor (void)

Viewport *	getCurrentRenderViewports (void)

virtual void	getCustomAttribute (const String &name, void *pData)
	Gets a custom (maybe platform-specific) attribute. More...

bool	getDebugShaders (void) const

virtual TextureGpu *	getDepthBufferFor (TextureGpu *colourTexture, uint16 poolId, bool preferDepthTexture, PixelFormatGpu depthBufferFormat)

unsigned int	getDisplayMonitorCount () const
	Gets the number of display monitors. More...

virtual const DriverVersion &	getDriverVersion (void) const
	Returns the driver version. More...

String	getErrorDescription (long errorNumber) const
	See RenderSystem. More...

const String &	getFriendlyName (void) const
	See RenderSystem. 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...

const GL3PlusSupport *	getGLSupport (void) const

Real	getHorizontalTexelOffset (void)
	Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...

virtual bool	getInvertVertexWinding (void) const
	Indicates whether or not the vertex windings set will be inverted for the current render (e.g. More...

uint32	getMaxBoundViewports (void)

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

const Metrics &	getMetrics () const

Real	getMinimumDepthInputValue (void)
	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...

const String &	getName (void) const
	See RenderSystem. More...

uint16	getNativeShadingLanguageVersion () const
	Gets the native shading language version for this render system. More...

virtual const StringVector &	getRenderSystemEvents (void) const
	Gets a list of the rendersystem specific events that this rendersystem can raise. More...

virtual Real	getRSDepthRange (void) 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 (void) const

TextureGpuManager *	getTextureGpuManager (void) const

VaoManager *	getVaoManager (void) const

Real	getVerticalTexelOffset (void)
	Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...

bool	getWBufferEnabled (void) const
	Returns true if the renderer will try to use W-buffers when available. More...

virtual bool	hasAnisotropicMipMapFilter () const
	Determines if the system has anisotropic mip map filter support. More...

virtual void	initGPUProfiling (void)

void	initialiseContext (Window *primary)

void	initialiseFromRenderSystemCapabilities (RenderSystemCapabilities caps, Window primary)
	See RenderSystem. More...

virtual bool	isGpuProgramBound (GpuProgramType gptype)
	Returns whether or not a Gpu program of the given type is currently bound. More...

bool	isReverseDepth (void) const

virtual bool	isStaticBufferLockable () const

virtual void	markProfileEvent (const String &eventName)
	Marks an instantaneous event for graphics profilers. More...

	OGRE_MUTEX (mThreadInitMutex)

void	operator delete (void *ptr)

void	operator delete (void ptr, void )

void	operator delete (void ptr, const char , int, const char *)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

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 *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info More...

void *	operator new[] (size_t sz)

void	postExtraThreadsStarted ()

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

void	queueBindUAVs (const DescriptorSetUav *descSetUav)
	Queues the binding of an UAV to the binding point/slot. More...

void	registerThread ()
	Register the an additional thread which may make calls to rendersystem-related objects. More...

void	reinitialise (void)
	See RenderSystem. 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...

void	setClipPlane (ushort index, Real A, Real B, Real C, Real D)
	See RenderSystem. More...

virtual void	setClipPlanes (const PlaneList &clipPlanes)
	Sets the user clipping region. More...

void	setClipPlanesImpl (const Ogre::PlaneList &planeList)
	Internal method used to set the underlying clip planes when needed. More...

void	setConfigOption (const String &name, const String &value)
	See RenderSystem. More...

virtual void	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...

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)
	See RenderSystem. 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...

void	shutdown (void)
	See RenderSystem. More...

void	unregisterThread ()
	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...

String	validateConfigOptions (void)
	See RenderSystem. 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 Listener *	getSharedListener (void)
	Retrieve a pointer to the current shared render system listener. More...

static CompareFunction	reverseCompareFunction (CompareFunction depthFunc)
	Reverts the compare order e.g. More...

static void	setSharedListener (Listener *listener)
	Sets shared listener. More...

Friends
class	ShaderGeneratorTechniqueResolverListener

Detailed Description

Implementation of GL 3 as a rendering system.

Constructor & Destructor Documentation

◆ GL3PlusRenderSystem()

Ogre::GL3PlusRenderSystem::GL3PlusRenderSystem ( )

◆ ~GL3PlusRenderSystem()

Ogre::GL3PlusRenderSystem::~GL3PlusRenderSystem ( )

Member Function Documentation

◆ _addMetrics()

void Ogre::RenderSystem::_addMetrics ( const Metrics & newMetrics )

inherited

◆ _beginFrame()

void Ogre::GL3PlusRenderSystem::_beginFrame ( void )

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _beginFrameOnce()

virtual void Ogre::RenderSystem::_beginFrameOnce ( void )

virtualinherited

Signifies the beginning of the main frame.

i.e. will only be called once per frame, not per viewport

Reimplemented in Ogre::MetalRenderSystem.

◆ _cleanupDepthBuffers()

void Ogre::RenderSystem::_cleanupDepthBuffers ( void )

inherited

◆ _convertOpenVrProjectionMatrix()

virtual void Ogre::GL3PlusRenderSystem::_convertOpenVrProjectionMatrix	(	const Matrix4 &	matrix,
		Matrix4 &	dest
	)

virtual

Converts an OpenVR projection matrix to have the proper depth range and reverse Z settings.

Parameters

matrix
dest

Reimplemented from Ogre::RenderSystem.

◆ _convertProjectionMatrix()

virtual void Ogre::GL3PlusRenderSystem::_convertProjectionMatrix	(	const Matrix4 &	matrix,
		Matrix4 &	dest
	)

virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ _createRenderWindow()

Window* Ogre::GL3PlusRenderSystem::_createRenderWindow	(	const String &	name,
		uint32	width,
		uint32	height,
		bool	fullScreen,
		const NameValuePairList *	miscParams = `0`
	)

virtual

Creates a new rendering window.

Remarks: This method creates a new rendering window as specified by the paramteters. The rendering system could be responible for only a single window (e.g. in the case of a game), or could be in charge of multiple ones (in the case of a level editor). The option to create the window as a child of another is therefore given. This method will create an appropriate subclass of RenderWindow depending on the API and platform implementation.

: After creation, this window can be retrieved using getRenderTarget().

Parameters

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

Implements Ogre::RenderSystem.

◆ _createRenderWindows()

bool Ogre::GL3PlusRenderSystem::_createRenderWindows	(	const RenderWindowDescriptionList &	renderWindowDescriptions,
		WindowList &	createdWindows
	)

virtual

Creates multiple rendering windows.

Parameters

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.

Returns: true on success.

Reimplemented from Ogre::RenderSystem.

◆ _dereferenceSharedDepthBuffer()

void Ogre::RenderSystem::_dereferenceSharedDepthBuffer ( TextureGpu * depthBuffer )

inherited

Releases the reference count on a shared depth buffer.

Does nothing if input is not a shared depth buffer.

◆ _descriptorSetSamplerCreated()

virtual void Ogre::RenderSystem::_descriptorSetSamplerCreated ( DescriptorSetSampler * newSet )

inlinevirtualinherited

◆ _descriptorSetSamplerDestroyed()

virtual void Ogre::RenderSystem::_descriptorSetSamplerDestroyed ( DescriptorSetSampler * set )

inlinevirtualinherited

◆ _descriptorSetTexture2Created()

virtual void Ogre::GL3PlusRenderSystem::_descriptorSetTexture2Created ( DescriptorSetTexture2 * newSet )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _descriptorSetTexture2Destroyed()

virtual void Ogre::GL3PlusRenderSystem::_descriptorSetTexture2Destroyed ( DescriptorSetTexture2 * set )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _descriptorSetTextureCreated()

virtual void Ogre::RenderSystem::_descriptorSetTextureCreated ( DescriptorSetTexture * newSet )

inlinevirtualinherited

Reimplemented in Ogre::D3D11RenderSystem.

◆ _descriptorSetTextureDestroyed()

virtual void Ogre::RenderSystem::_descriptorSetTextureDestroyed ( DescriptorSetTexture * set )

inlinevirtualinherited

Reimplemented in Ogre::D3D11RenderSystem.

◆ _descriptorSetUavCreated()

virtual void Ogre::GL3PlusRenderSystem::_descriptorSetUavCreated ( DescriptorSetUav * newSet )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _descriptorSetUavDestroyed()

virtual void Ogre::GL3PlusRenderSystem::_descriptorSetUavDestroyed ( DescriptorSetUav * set )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _dispatch()

virtual void Ogre::GL3PlusRenderSystem::_dispatch ( const HlmsComputePso & pso )

virtual

Implements Ogre::RenderSystem.

◆ _endFrame()

void Ogre::GL3PlusRenderSystem::_endFrame ( void )

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _endFrameOnce()

virtual void Ogre::RenderSystem::_endFrameOnce ( void )

virtualinherited

Called once per frame, regardless of how many active workspaces there are.

Gets called AFTER all RenderWindows have been swapped.

Reimplemented in Ogre::MetalRenderSystem.

◆ _executeResourceTransition()

virtual void Ogre::GL3PlusRenderSystem::_executeResourceTransition ( ResourceTransition * resTransition )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _getCurrentRenderViewport()

Viewport& Ogre::RenderSystem::_getCurrentRenderViewport ( void )

inlineinherited

◆ _getDefaultViewportMaterialScheme()

virtual const String& Ogre::RenderSystem::_getDefaultViewportMaterialScheme ( void ) const

virtualinherited

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().

◆ _getFrameBufferDescMap()

virtual GL3PlusFrameBufferDescMap& Ogre::GL3PlusRenderSystem::_getFrameBufferDescMap ( void )

inlinevirtual

◆ _getMainContext()

GL3PlusContext* Ogre::GL3PlusRenderSystem::_getMainContext ( )

inline

Returns the main context.

◆ _hlmsBlendblockCreated()

virtual void Ogre::GL3PlusRenderSystem::_hlmsBlendblockCreated ( HlmsBlendblock * newBlock )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsBlendblockDestroyed()

virtual void Ogre::GL3PlusRenderSystem::_hlmsBlendblockDestroyed ( HlmsBlendblock * block )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsComputePipelineStateObjectCreated()

virtual void Ogre::GL3PlusRenderSystem::_hlmsComputePipelineStateObjectCreated ( HlmsComputePso * newPso )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsComputePipelineStateObjectDestroyed()

virtual void Ogre::GL3PlusRenderSystem::_hlmsComputePipelineStateObjectDestroyed ( HlmsComputePso * newPso )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsMacroblockCreated()

virtual void Ogre::GL3PlusRenderSystem::_hlmsMacroblockCreated ( HlmsMacroblock * newBlock )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsMacroblockDestroyed()

virtual void Ogre::GL3PlusRenderSystem::_hlmsMacroblockDestroyed ( HlmsMacroblock * block )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsPipelineStateObjectCreated()

virtual void Ogre::GL3PlusRenderSystem::_hlmsPipelineStateObjectCreated ( HlmsPso * newPso )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsPipelineStateObjectDestroyed()

virtual void Ogre::GL3PlusRenderSystem::_hlmsPipelineStateObjectDestroyed ( HlmsPso * pso )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsSamplerblockCreated()

virtual void Ogre::GL3PlusRenderSystem::_hlmsSamplerblockCreated ( HlmsSamplerblock * newBlock )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _hlmsSamplerblockDestroyed()

virtual void Ogre::GL3PlusRenderSystem::_hlmsSamplerblockDestroyed ( HlmsSamplerblock * block )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _initialise()

Window* Ogre::GL3PlusRenderSystem::_initialise	(	bool	autoCreateWindow,
		const String &	windowTitle = `"OGRE Render Window"`
	)

virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ _makeRsProjectionMatrix()

virtual void Ogre::GL3PlusRenderSystem::_makeRsProjectionMatrix	(	const Matrix4 &	matrix,
		Matrix4 &	dest,
		Real	nearPlane,
		Real	farPlane,
		ProjectionType	projectionType
	)

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

Parameters

matrix
dest
nearPlane
farPlane
projectionType

Reimplemented from Ogre::RenderSystem.

◆ _oneTimeContextInitialization()

void Ogre::GL3PlusRenderSystem::_oneTimeContextInitialization ( )

One time initialization for the RenderState of a context.

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

◆ _pauseFrame()

virtual RenderSystemContext* Ogre::RenderSystem::_pauseFrame ( void )

virtualinherited

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.

Reimplemented in Ogre::D3D9RenderSystem.

◆ _render() [1/5]

void Ogre::GL3PlusRenderSystem::_render ( const v1::RenderOperation & op )

virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ _render() [2/5]

virtual void Ogre::GL3PlusRenderSystem::_render ( const CbDrawCallIndexed * cmd )

virtual

Renders the VAO. Assumes _setVertexArrayObject has already been called.

Implements Ogre::RenderSystem.

◆ _render() [3/5]

virtual void Ogre::GL3PlusRenderSystem::_render ( const CbDrawCallStrip * cmd )

virtual

Implements Ogre::RenderSystem.

◆ _render() [4/5]

virtual void Ogre::GL3PlusRenderSystem::_render ( const v1::CbDrawCallIndexed * cmd )

virtual

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

Implements Ogre::RenderSystem.

◆ _render() [5/5]

virtual void Ogre::GL3PlusRenderSystem::_render ( const v1::CbDrawCallStrip * cmd )

virtual

Implements Ogre::RenderSystem.

◆ _renderEmulated() [1/2]

virtual void Ogre::GL3PlusRenderSystem::_renderEmulated ( const CbDrawCallIndexed * cmd )

virtual

Implements Ogre::RenderSystem.

◆ _renderEmulated() [2/2]

virtual void Ogre::GL3PlusRenderSystem::_renderEmulated ( const CbDrawCallStrip * cmd )

virtual

Implements Ogre::RenderSystem.

◆ _renderEmulatedNoBaseInstance() [1/2]

virtual void Ogre::GL3PlusRenderSystem::_renderEmulatedNoBaseInstance ( const CbDrawCallIndexed * cmd )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _renderEmulatedNoBaseInstance() [2/2]

virtual void Ogre::GL3PlusRenderSystem::_renderEmulatedNoBaseInstance ( const CbDrawCallStrip * cmd )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _renderNoBaseInstance() [1/2]

virtual void Ogre::GL3PlusRenderSystem::_renderNoBaseInstance ( const v1::CbDrawCallIndexed * cmd )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _renderNoBaseInstance() [2/2]

virtual void Ogre::GL3PlusRenderSystem::_renderNoBaseInstance ( const v1::CbDrawCallStrip * cmd )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _resetMetrics()

void Ogre::RenderSystem::_resetMetrics ( )

inherited

◆ _resourceTransitionCreated()

virtual void Ogre::GL3PlusRenderSystem::_resourceTransitionCreated ( ResourceTransition * resTransition )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _resourceTransitionDestroyed()

virtual void Ogre::GL3PlusRenderSystem::_resourceTransitionDestroyed ( ResourceTransition * resTransition )

virtual

Reimplemented from Ogre::RenderSystem.

◆ _resumeFrame()

virtual void Ogre::RenderSystem::_resumeFrame ( RenderSystemContext * context )

virtualinherited

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.

Parameters

context the render system context, as returned by _pauseFrame

Reimplemented in Ogre::D3D9RenderSystem.

◆ _setBindingType()

virtual void Ogre::RenderSystem::_setBindingType ( TextureUnitState::BindingType bindigType )

virtualinherited

Set texture unit binding type.

Reimplemented in Ogre::D3D11RenderSystem.

◆ _setComputePso()

virtual void Ogre::GL3PlusRenderSystem::_setComputePso ( const HlmsComputePso * pso )

virtual

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

Implements Ogre::RenderSystem.

◆ _setCurrentDeviceFromTexture()

virtual void Ogre::GL3PlusRenderSystem::_setCurrentDeviceFromTexture ( TextureGpu * texture )

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.

Parameters

texture Cannot be null.

Implements Ogre::RenderSystem.

◆ _setDepthBias()

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

See RenderSystem.

◆ _setGeometryTexture()

void Ogre::GL3PlusRenderSystem::_setGeometryTexture	(	size_t	unit,
		TextureGpu *	tex
	)

virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ _setHlmsBlendblock()

void Ogre::GL3PlusRenderSystem::_setHlmsBlendblock	(	const HlmsBlendblock *	blendblock,
		const GL3PlusHlmsPso *	pso
	)

◆ _setHlmsMacroblock()

void Ogre::GL3PlusRenderSystem::_setHlmsMacroblock	(	const HlmsMacroblock *	macroblock,
		const GL3PlusHlmsPso *	pso
	)

◆ _setHlmsSamplerblock()

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

virtual

HlmsSamplerblock.

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

Implements Ogre::RenderSystem.

◆ _setIndirectBuffer()

virtual void Ogre::GL3PlusRenderSystem::_setIndirectBuffer ( IndirectBufferPacked * indirectBuffer )

virtual

Implements Ogre::RenderSystem.

◆ _setPipelineStateObject()

virtual void Ogre::GL3PlusRenderSystem::_setPipelineStateObject ( const HlmsPso * pso )

virtual

HlmsPso

Reimplemented from Ogre::RenderSystem.

◆ _setPointParameters()

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

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setPointSpritesEnabled()

void Ogre::GL3PlusRenderSystem::_setPointSpritesEnabled ( bool enabled )

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setProjectionMatrix()

void Ogre::GL3PlusRenderSystem::_setProjectionMatrix ( const Matrix4 & m )

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setRenderOperation()

virtual void Ogre::GL3PlusRenderSystem::_setRenderOperation ( const v1::CbRenderOp * cmd )

virtual

Implements Ogre::RenderSystem.

◆ _setSamplers()

virtual void Ogre::GL3PlusRenderSystem::_setSamplers	(	uint32	slotStart,
		const DescriptorSetSampler *	set
	)

virtual

Implements Ogre::RenderSystem.

◆ _setSamplersCS()

virtual void Ogre::GL3PlusRenderSystem::_setSamplersCS	(	uint32	slotStart,
		const DescriptorSetSampler *	set
	)

virtual

Implements Ogre::RenderSystem.

◆ _setSceneBlending()

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

◆ _setSceneBlendingOperation()

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

◆ _setSeparateSceneBlending()

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

◆ _setSeparateSceneBlendingOperation()

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

◆ _setSurfaceParams()

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

inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setTessellationDomainTexture()

void Ogre::GL3PlusRenderSystem::_setTessellationDomainTexture	(	size_t	unit,
		TextureGpu *	tex
	)

virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ _setTessellationHullTexture()

void Ogre::GL3PlusRenderSystem::_setTessellationHullTexture	(	size_t	unit,
		TextureGpu *	tex
	)

virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ _setTexture()

void Ogre::GL3PlusRenderSystem::_setTexture	(	size_t	unit,
		TextureGpu *	tex
	)

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setTextureBlendMode()

void Ogre::GL3PlusRenderSystem::_setTextureBlendMode	(	size_t	stage,
		const LayerBlendModeEx &	bm
	)

inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setTextureCoordCalculation()

void Ogre::GL3PlusRenderSystem::_setTextureCoordCalculation	(	size_t	stage,
		TexCoordCalcMethod	m,
		const Frustum *	frustum = `0`
	)

inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setTextureMatrix()

void Ogre::GL3PlusRenderSystem::_setTextureMatrix	(	size_t	stage,
		const Matrix4 &	xform
	)

inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setTextureProjectionRelativeTo()

virtual void Ogre::RenderSystem::_setTextureProjectionRelativeTo	(	bool	enabled,
		const Vector3 &	pos
	)

virtualinherited

Notify the rendersystem that it should adjust texture projection to be relative to a different origin.

◆ _setTextures() [1/2]

virtual void Ogre::GL3PlusRenderSystem::_setTextures	(	uint32	slotStart,
		const DescriptorSetTexture *	set,
		uint32	hazardousTexIdx
	)

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setTextures() [2/2]

virtual void Ogre::GL3PlusRenderSystem::_setTextures	(	uint32	slotStart,
		const DescriptorSetTexture2 *	set
	)

virtual

Implements Ogre::RenderSystem.

◆ _setTexturesCS() [1/2]

virtual void Ogre::GL3PlusRenderSystem::_setTexturesCS	(	uint32	slotStart,
		const DescriptorSetTexture *	set
	)

virtual

Implements Ogre::RenderSystem.

◆ _setTexturesCS() [2/2]

virtual void Ogre::GL3PlusRenderSystem::_setTexturesCS	(	uint32	slotStart,
		const DescriptorSetTexture2 *	set
	)

virtual

Implements Ogre::RenderSystem.

◆ _setTextureUnitSettings()

virtual void Ogre::RenderSystem::_setTextureUnitSettings	(	size_t	texUnit,
		TextureUnitState &	tl
	)

virtualinherited

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.

◆ _setUavCS()

virtual void Ogre::GL3PlusRenderSystem::_setUavCS	(	uint32	slotStart,
		const DescriptorSetUav *	set
	)

virtual

Implements Ogre::RenderSystem.

◆ _setVertexArrayObject()

virtual void Ogre::GL3PlusRenderSystem::_setVertexArrayObject ( const VertexArrayObject * vao )

virtual

Part of the low level rendering interface.

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

Remarks: Assumes _setPipelineStateObject has already been called.

Implements Ogre::RenderSystem.

◆ _setVertexTexture()

void Ogre::GL3PlusRenderSystem::_setVertexTexture	(	size_t	unit,
		TextureGpu *	tex
	)

virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ _setViewMatrix()

void Ogre::GL3PlusRenderSystem::_setViewMatrix ( const Matrix4 & m )

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _setWorldMatrices()

virtual void Ogre::RenderSystem::_setWorldMatrices	(	const Matrix4 *	m,
		unsigned short	count
	)

virtualinherited

Sets multiple world matrices (vertex blending).

◆ _setWorldMatrix()

void Ogre::GL3PlusRenderSystem::_setWorldMatrix ( const Matrix4 & m )

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ _startLegacyV1Rendering()

virtual void Ogre::GL3PlusRenderSystem::_startLegacyV1Rendering ( void )

virtual

May override the current VertexArrayObject!

Reimplemented from Ogre::RenderSystem.

◆ _switchContext()

void Ogre::GL3PlusRenderSystem::_switchContext ( GL3PlusContext * context )

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

◆ _unregisterContext()

void Ogre::GL3PlusRenderSystem::_unregisterContext ( GL3PlusContext * context )

Unregister a render target->context mapping.

If the context of target is the current context, change the context to the main context so it can be destroyed safely.

Note: This is automatically called by the destructor of GL3PlusContext.

◆ _update()

void Ogre::RenderSystem::_update ( void )

inherited

Called once per frame, regardless of how many active workspaces there are.

◆ _useLights()

void Ogre::GL3PlusRenderSystem::_useLights	(	const LightList &	lights,
		unsigned short	limit
	)

inlinevirtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ addClipPlane() [1/2]

virtual void Ogre::RenderSystem::addClipPlane ( const Plane & p )

virtualinherited

Add a user clipping plane.

◆ addClipPlane() [2/2]

virtual void Ogre::RenderSystem::addClipPlane	(	Real	A,
		Real	B,
		Real	C,
		Real	D
	)

virtualinherited

Add a user clipping plane.

◆ addListener()

virtual void Ogre::RenderSystem::addListener ( Listener * l )

virtualinherited

Adds a listener to the custom events that this render system can raise.

Remarks: Some render systems have quite specific, internally generated events that the application may wish to be notified of. Many applications don't have to worry about these events, and can just trust OGRE to handle them, but if you want to know, you can add a listener here.

: Events are raised very generically by string name. Perhaps the most common example of a render system specific event is the loss and restoration of a device in DirectX; which OGRE deals with, but you may wish to know when it happens.

See also: RenderSystem::getRenderSystemEvents

◆ areFixedFunctionLightsInViewSpace()

bool Ogre::GL3PlusRenderSystem::areFixedFunctionLightsInViewSpace ( ) const

inlinevirtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ beginGPUSampleProfile()

virtual void Ogre::GL3PlusRenderSystem::beginGPUSampleProfile	(	const String &	name,
		uint32 *	hashCache
	)

virtual

Implements Ogre::RenderSystem.

◆ beginProfileEvent()

virtual void Ogre::GL3PlusRenderSystem::beginProfileEvent ( const String & eventName )

virtual

This marks the beginning of an event for GPU profiling.

Implements Ogre::RenderSystem.

◆ beginRenderPassDescriptor()

virtual void Ogre::GL3PlusRenderSystem::beginRenderPassDescriptor	(	RenderPassDescriptor *	desc,
		TextureGpu *	anyTarget,
		uint8	mipLevel,
		const Vector4 *	viewportSizes,
		const Vector4 *	scissors,
		uint32	numViewports,
		bool	overlaysEnabled,
		bool	warnIfRtvWasFlushed
	)

virtual

When the descriptor is set to Load clear, two possible things may happen:

The region is cleared.
The whole texture is cleared. What actually happens is undefined (depends on the API). But calling "beginRenderPassDescriptor( desc, viewportSettings );" with the same descriptor but different viewports (without changing the desc) guarantees that each region is cleared:

Each time the subregion is switched

Only once (the whole texture), when the first viewport was set.

: When switching between render targets, two beginRenderPassDescriptor in a row automatically implies calls endRenderPassDescriptor. In fact this is faster to perfom than calling beginRenderPassDescriptor - endRenderPassDescriptor in pairs, because we can smartly flush only what needs to be flushed. endRenderPassDescriptor only needs to be called when no other beginRenderPassDescriptor will follow (i.e. at the end of the frame or when starting compute jobs)

Parameters

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 from Ogre::RenderSystem.

◆ bindGpuProgramParameters()

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

virtual

Bind Gpu program parameters.

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.

◆ bindGpuProgramPassIterationParameters()

void Ogre::GL3PlusRenderSystem::bindGpuProgramPassIterationParameters ( GpuProgramType gptype )

virtual

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

Implements Ogre::RenderSystem.

◆ clearFrameBuffer()

virtual void Ogre::GL3PlusRenderSystem::clearFrameBuffer	(	RenderPassDescriptor *	renderPassDesc,
		TextureGpu *	anyTarget,
		uint8	mipLevel
	)

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:

Backwards compatibility (i.e. easier porting from 2.1)
Non-tilers desktop GPUs may be faster to clear the whole framebuffer at once.
Remarks
Will break an existing RenderPassDescriptor set via beginRenderPassDescriptor.

Parameters

renderPassDesc RenderPassDescriptor filled with LoadActions set to clear and StoreActions set to Store.

Implements Ogre::RenderSystem.

◆ convertColourValue()

virtual void Ogre::RenderSystem::convertColourValue	(	const ColourValue &	colour,
		uint32 *	pDest
	)

virtualinherited

Generates a packed data version of the passed in ColourValue suitable for use as with this RenderSystem.

Remarks: Since different render systems have different colour data formats (eg RGBA for GL, ARGB for D3D) this method allows you to use 1 method for all.

Parameters

colour	The colour to convert
pDest	Pointer to location to put the result.

◆ convertCompareFunction()

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

◆ convertStencilOp()

GLint Ogre::GL3PlusRenderSystem::convertStencilOp ( StencilOperation op ) const

◆ createDepthBufferFor()

TextureGpu* Ogre::GL3PlusRenderSystem::createDepthBufferFor	(	TextureGpu *	colourTexture,
		bool	preferDepthTexture,
		PixelFormatGpu	depthBufferFormat,
		uint16	poolId
	)

virtual

Reimplemented from Ogre::RenderSystem.

◆ createHardwareOcclusionQuery()

HardwareOcclusionQuery* Ogre::GL3PlusRenderSystem::createHardwareOcclusionQuery ( void )

virtual

Create an object for performing hardware occlusion queries.

Implements Ogre::RenderSystem.

◆ createRenderPassDescriptor()

virtual RenderPassDescriptor* Ogre::GL3PlusRenderSystem::createRenderPassDescriptor ( void )

virtual

Implements Ogre::RenderSystem.

◆ createRenderSystemCapabilities()

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

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ deinitGPUProfiling()

virtual void Ogre::GL3PlusRenderSystem::deinitGPUProfiling ( void )

virtual

Implements Ogre::RenderSystem.

◆ destroyHardwareOcclusionQuery()

virtual void Ogre::RenderSystem::destroyHardwareOcclusionQuery ( HardwareOcclusionQuery * hq )

virtualinherited

Destroy a hardware occlusion query object.

◆ destroyRenderPassDescriptor()

void Ogre::RenderSystem::destroyRenderPassDescriptor ( RenderPassDescriptor * renderPassDesc )

inherited

◆ destroyRenderWindow()

virtual void Ogre::RenderSystem::destroyRenderWindow ( Window * window )

virtualinherited

Destroys a render window.

◆ enableClipPlane()

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

See RenderSystem.

◆ endGPUSampleProfile()

virtual void Ogre::GL3PlusRenderSystem::endGPUSampleProfile ( const String & name )

virtual

Implements Ogre::RenderSystem.

◆ endProfileEvent()

virtual void Ogre::GL3PlusRenderSystem::endProfileEvent ( void )

virtual

Ends the currently active GPU profiling event.

Implements Ogre::RenderSystem.

◆ endRenderPassDescriptor()

virtual void Ogre::GL3PlusRenderSystem::endRenderPassDescriptor ( void )

virtual

Reimplemented from Ogre::RenderSystem.

◆ executeRenderPassDescriptorDelayedActions()

virtual void Ogre::RenderSystem::executeRenderPassDescriptorDelayedActions ( void )

virtualinherited

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::MetalRenderSystem.

◆ flushUAVs()

virtual void Ogre::GL3PlusRenderSystem::flushUAVs ( void )

virtual

Forces to take effect all the queued UAV binding requests.

See also: _queueBindUAV. You don't need to call this if you're going to set the render target next.

Implements Ogre::RenderSystem.

◆ getCapabilities()

const RenderSystemCapabilities* Ogre::RenderSystem::getCapabilities ( void ) const

inlineinherited

Gets the capabilities of the render system.

◆ getColourVertexElementType()

VertexElementType Ogre::GL3PlusRenderSystem::getColourVertexElementType ( void ) const

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ getConfigOptions()

ConfigOptionMap& Ogre::GL3PlusRenderSystem::getConfigOptions ( void )

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ getCurrentPassDescriptor()

RenderPassDescriptor* Ogre::RenderSystem::getCurrentPassDescriptor ( void )

inlineinherited

◆ getCurrentRenderViewports()

Viewport* Ogre::RenderSystem::getCurrentRenderViewports ( void )

inlineinherited

◆ getCustomAttribute()

virtual void Ogre::RenderSystem::getCustomAttribute	(	const String &	name,
		void *	pData
	)

virtualinherited

Gets a custom (maybe platform-specific) attribute.

Remarks: This is a nasty way of satisfying any API's need to see platform-specific details.

Parameters

name	The name of the attribute.
pData	Pointer to memory of the right kind of structure to receive the info.

Reimplemented in Ogre::D3D11RenderSystem.

◆ getDebugShaders()

bool Ogre::RenderSystem::getDebugShaders ( void ) const

inlineinherited

◆ getDepthBufferFor()

virtual TextureGpu* Ogre::RenderSystem::getDepthBufferFor	(	TextureGpu *	colourTexture,
		uint16	poolId,
		bool	preferDepthTexture,
		PixelFormatGpu	depthBufferFormat
	)

virtualinherited

◆ getDisplayMonitorCount()

unsigned int Ogre::GL3PlusRenderSystem::getDisplayMonitorCount ( ) const

virtual

Gets the number of display monitors.

See also: Root::getDisplayMonitorCount

Implements Ogre::RenderSystem.

◆ getDriverVersion()

virtual const DriverVersion& Ogre::RenderSystem::getDriverVersion ( void ) const

inlinevirtualinherited

Returns the driver version.

◆ getErrorDescription()

String Ogre::GL3PlusRenderSystem::getErrorDescription ( long errorNumber ) const

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ getFriendlyName()

const String& Ogre::GL3PlusRenderSystem::getFriendlyName ( void ) const

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ getGlobalInstanceVertexBuffer()

v1::HardwareVertexBufferSharedPtr Ogre::RenderSystem::getGlobalInstanceVertexBuffer ( ) const

inherited

Returns the global instance vertex buffer.

◆ getGlobalInstanceVertexBufferVertexDeclaration()

v1::VertexDeclaration* Ogre::RenderSystem::getGlobalInstanceVertexBufferVertexDeclaration ( ) const

inherited

Gets vertex declaration for the global vertex buffer for the global instancing.

◆ getGlobalNumberOfInstances()

size_t Ogre::RenderSystem::getGlobalNumberOfInstances ( ) const

inherited

Gets the global number of instances.

◆ getGLSupport()

const GL3PlusSupport* Ogre::GL3PlusRenderSystem::getGLSupport ( void ) const

inline

◆ getHorizontalTexelOffset()

Real Ogre::GL3PlusRenderSystem::getHorizontalTexelOffset ( void )

inlinevirtual

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

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

Implements Ogre::RenderSystem.

◆ getInvertVertexWinding()

virtual bool Ogre::RenderSystem::getInvertVertexWinding ( void ) const

virtualinherited

Indicates whether or not the vertex windings set will be inverted for the current render (e.g.

reflections)

See also: RenderSystem::setInvertVertexWinding

◆ getMaxBoundViewports()

uint32 Ogre::RenderSystem::getMaxBoundViewports ( void )

inlineinherited

◆ getMaximumDepthInputValue()

Real Ogre::GL3PlusRenderSystem::getMaximumDepthInputValue ( void )

virtual

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

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

See also: Renderable::getUseIdentityView, Renderable::getUseIdentityProjection

Implements Ogre::RenderSystem.

◆ getMetrics()

const Metrics& Ogre::RenderSystem::getMetrics ( ) const

inherited

◆ getMinimumDepthInputValue()

Real Ogre::GL3PlusRenderSystem::getMinimumDepthInputValue ( void )

virtual

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

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

See also: Renderable::getUseIdentityView, Renderable::getUseIdentityProjection

Implements Ogre::RenderSystem.

◆ getMutableCapabilities()

RenderSystemCapabilities* Ogre::RenderSystem::getMutableCapabilities ( )

inlineinherited

Get a pointer to the current capabilities being used by the RenderSystem.

Remarks: The capabilities may be modified using this pointer, this will only have an effect before the RenderSystem has been initialised. It's intended use is to allow a listener of the RenderSystemCapabilitiesCreated event to customise the capabilities on the fly before the RenderSystem is initialised.

◆ getName()

const String& Ogre::GL3PlusRenderSystem::getName ( void ) const

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ getNativeShadingLanguageVersion()

uint16 Ogre::RenderSystem::getNativeShadingLanguageVersion ( ) const

inlineinherited

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

◆ getRenderSystemEvents()

virtual const StringVector& Ogre::RenderSystem::getRenderSystemEvents ( void ) const

inlinevirtualinherited

Gets a list of the rendersystem specific events that this rendersystem can raise.

See also: RenderSystem::addListener

◆ getRSDepthRange()

virtual Real Ogre::GL3PlusRenderSystem::getRSDepthRange ( void ) const

virtual

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 from Ogre::RenderSystem.

◆ getSharedListener()

static Listener* Ogre::RenderSystem::getSharedListener ( void )

staticinherited

Retrieve a pointer to the current shared render system listener.

◆ getStencilBufferParams()

const StencilParams& Ogre::RenderSystem::getStencilBufferParams ( void ) const

inlineinherited

◆ getTextureGpuManager()

TextureGpuManager* Ogre::RenderSystem::getTextureGpuManager ( void ) const

inlineinherited

◆ getVaoManager()

VaoManager* Ogre::RenderSystem::getVaoManager ( void ) const

inlineinherited

◆ getVerticalTexelOffset()

Real Ogre::GL3PlusRenderSystem::getVerticalTexelOffset ( void )

inlinevirtual

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

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

Implements Ogre::RenderSystem.

References OGRE_MUTEX.

◆ getWBufferEnabled()

bool Ogre::RenderSystem::getWBufferEnabled ( void ) const

inherited

Returns true if the renderer will try to use W-buffers when available.

◆ hasAnisotropicMipMapFilter()

virtual bool Ogre::GL3PlusRenderSystem::hasAnisotropicMipMapFilter ( ) const

inlinevirtual

Determines if the system has anisotropic mip map filter support.

Implements Ogre::RenderSystem.

◆ initGPUProfiling()

virtual void Ogre::GL3PlusRenderSystem::initGPUProfiling ( void )

virtual

Implements Ogre::RenderSystem.

◆ initialiseContext()

void Ogre::GL3PlusRenderSystem::initialiseContext ( Window * primary )

◆ initialiseFromRenderSystemCapabilities()

void Ogre::GL3PlusRenderSystem::initialiseFromRenderSystemCapabilities	(	RenderSystemCapabilities *	caps,
		Window *	primary
	)

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ isGpuProgramBound()

virtual bool Ogre::RenderSystem::isGpuProgramBound ( GpuProgramType gptype )

virtualinherited

Returns whether or not a Gpu program of the given type is currently bound.

◆ isReverseDepth()

bool Ogre::RenderSystem::isReverseDepth ( void ) const

inlineinherited

References OGRE_MAX_TEXTURE_LAYERS.

◆ isStaticBufferLockable()

virtual bool Ogre::RenderSystem::isStaticBufferLockable ( ) const

inlinevirtualinherited

Reimplemented in Ogre::D3D9RenderSystem.

◆ markProfileEvent()

virtual void Ogre::GL3PlusRenderSystem::markProfileEvent ( const String & eventName )

virtual

Marks an instantaneous event for graphics profilers.

This is equivalent to calling

See also: beginProfileEvent and; endProfileEvent back to back.

Implements Ogre::RenderSystem.

◆ OGRE_MUTEX()

Ogre::GL3PlusRenderSystem::OGRE_MUTEX ( mThreadInitMutex )

◆ operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inlineinherited

◆ operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)

inlineinherited

◆ operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr )

inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

operator new, with debug line info

◆ operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz )

inlineinherited

◆ operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)

inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

array operator new, with debug line info

◆ operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz )

inlineinherited

◆ postExtraThreadsStarted()

void Ogre::GL3PlusRenderSystem::postExtraThreadsStarted ( )

virtual

Implements Ogre::RenderSystem.

◆ preExtraThreadsStarted()

void Ogre::GL3PlusRenderSystem::preExtraThreadsStarted ( )

virtual

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

Remarks

Call this from your main thread before starting your other threads (which themselves should call registerThread()). Note that if you start your own threads, there is a specific startup sequence which must be respected and requires synchronisation between the threads:

[Main thread]Call preExtraThreadsStarted
[Main thread]Start other thread, wait
[Other thread]Call registerThread, notify main thread & continue
[Main thread]Wake up & call postExtraThreadsStarted

Once this init sequence is completed the threads are independent but this startup sequence must be respected.

Implements Ogre::RenderSystem.

◆ queueBindUAVs()

void Ogre::RenderSystem::queueBindUAVs ( const DescriptorSetUav * descSetUav )

inherited

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.

Remarks: Internal Developer Notes: D3D11 keeps UAVs that affect rendering separate from UAVs that affect Compute Shaders. Hence queueBindUAVs & _setTextureCS are independent.

OpenGL however, does not make this distinction. Hence once we switch back to 3D rendering, we need to restore UAVs set via queueBindUAV.

◆ registerThread()

void Ogre::GL3PlusRenderSystem::registerThread ( )

virtual

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

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

Note: This method takes no parameters - it must be called from the thread being registered and that context is enough.

Implements Ogre::RenderSystem.

◆ reinitialise()

void Ogre::GL3PlusRenderSystem::reinitialise ( void )

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ removeListener()

virtual void Ogre::RenderSystem::removeListener ( Listener * l )

virtualinherited

Remove a listener to the custom events that this render system can raise.

◆ resetClipPlanes()

virtual void Ogre::RenderSystem::resetClipPlanes ( )

virtualinherited

Clears the user clipping region.

◆ reverseCompareFunction()

static CompareFunction Ogre::RenderSystem::reverseCompareFunction ( CompareFunction depthFunc )

staticinherited

Reverts the compare order e.g.

greater_equal becomes less_equal Used by reverse depth

Parameters

depthFunc

Returns

◆ setClipPlane()

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

See RenderSystem.

◆ setClipPlanes()

virtual void Ogre::RenderSystem::setClipPlanes ( const PlaneList & clipPlanes )

virtualinherited

Sets the user clipping region.

◆ setClipPlanesImpl()

void Ogre::GL3PlusRenderSystem::setClipPlanesImpl ( const Ogre::PlaneList & clipPlanes )

virtual

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

Implements Ogre::RenderSystem.

◆ setConfigOption()

void Ogre::GL3PlusRenderSystem::setConfigOption	(	const String &	name,
		const String &	value
	)

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ setCurrentPassIterationCount()

virtual void Ogre::RenderSystem::setCurrentPassIterationCount ( const size_t count )

inlinevirtualinherited

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.

Parameters

count Number of times to render the current state.

◆ setDebugShaders()

void Ogre::RenderSystem::setDebugShaders ( bool bDebugShaders )

inherited

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.

◆ setDeriveDepthBias()

virtual void Ogre::RenderSystem::setDeriveDepthBias	(	bool	derive,
		float	baseValue = `0.0f`,
		float	multiplier = `0.0f`,
		float	slopeScale = `0.0f`
	)

inlinevirtualinherited

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

Parameters

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

◆ setGlobalInstanceVertexBuffer()

void Ogre::RenderSystem::setGlobalInstanceVertexBuffer ( const v1::HardwareVertexBufferSharedPtr & val )

inherited

Sets the global instance vertex buffer.

◆ setGlobalInstanceVertexBufferVertexDeclaration()

void Ogre::RenderSystem::setGlobalInstanceVertexBufferVertexDeclaration ( v1::VertexDeclaration * val )

inherited

Sets vertex declaration for the global vertex buffer for the global instancing.

◆ setGlobalNumberOfInstances()

void Ogre::RenderSystem::setGlobalNumberOfInstances ( const size_t val )

inherited

Sets the global number of instances.

◆ setInvertVertexWinding()

void Ogre::RenderSystem::setInvertVertexWinding ( bool invert )

inherited

Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections.

◆ setMetricsRecordingEnabled()

void Ogre::RenderSystem::setMetricsRecordingEnabled ( bool bEnable )

inherited

◆ setSharedListener()

static void Ogre::RenderSystem::setSharedListener ( Listener * listener )

staticinherited

Sets shared listener.

Remarks: Shared listener could be set even if no render system is selected yet. This listener will receive "RenderSystemChanged" event on each Root::setRenderSystem call.

◆ setStencilBufferParams()

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

virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ setUavStartingSlot()

void Ogre::RenderSystem::setUavStartingSlot ( uint32 startingSlot )

inherited

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 )

: Ogre will raise an exception in D3D11 if the starting slot is lower than the number of attached RTs, but will let it pass if you're using GL3+ [TODO: Make this behavior consistent?]

Remarks: Will not take effect until the next call to flushUAVs or setting a new RTT.

Parameters

startingSlot Default value: 1.

◆ setWBufferEnabled()

void Ogre::RenderSystem::setWBufferEnabled ( bool enabled )

inherited

Sets whether or not W-buffers are enabled if they are available for this renderer.

Parameters

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.

◆ shutdown()

void Ogre::GL3PlusRenderSystem::shutdown ( void )

virtual

See RenderSystem.

Reimplemented from Ogre::RenderSystem.

◆ unregisterThread()

void Ogre::GL3PlusRenderSystem::unregisterThread ( )

virtual

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

See also: RenderSystem::registerThread

Implements Ogre::RenderSystem.

◆ updateCompositorManager()

virtual void Ogre::RenderSystem::updateCompositorManager ( CompositorManager2 * compositorManager )

virtualinherited

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.

◆ useCustomRenderSystemCapabilities()

virtual void Ogre::RenderSystem::useCustomRenderSystemCapabilities ( RenderSystemCapabilities * capabilities )

virtualinherited

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)

Parameters

capabilities has to be a subset of the real capabilities and the caller is responsible for deallocating capabilities.

◆ validateConfigOptions()

String Ogre::GL3PlusRenderSystem::validateConfigOptions ( void )

virtual

See RenderSystem.

Implements Ogre::RenderSystem.

◆ validateDevice()

virtual bool Ogre::RenderSystem::validateDevice ( bool forceDeviceElection = false )

inlinevirtualinherited

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.

References Ogre::RenderWindowDescription::height, Ogre::RenderWindowDescription::miscParams, Ogre::RenderWindowDescription::name, and Ogre::RenderWindowDescription::width.

◆ validateSampleDescription()

virtual SampleDescription Ogre::RenderSystem::validateSampleDescription	(	const SampleDescription &	sampleDesc,
		PixelFormatGpu	format
	)

virtualinherited

Returns supported sample description for requested FSAA mode, with graceful downgrading.

Reimplemented in Ogre::D3D11RenderSystem, and Ogre::MetalRenderSystem.

Friends And Related Function Documentation

◆ ShaderGeneratorTechniqueResolverListener

friend class ShaderGeneratorTechniqueResolverListener

friend

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

OgreGL3PlusRenderSystem.h

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GL3PlusRenderSystem()

◆ ~GL3PlusRenderSystem()

Member Function Documentation

◆ _addMetrics()

◆ _beginFrame()

◆ _beginFrameOnce()

◆ _cleanupDepthBuffers()

◆ _convertOpenVrProjectionMatrix()

◆ _convertProjectionMatrix()

◆ _createRenderWindow()

◆ _createRenderWindows()

◆ _dereferenceSharedDepthBuffer()

◆ _descriptorSetSamplerCreated()

◆ _descriptorSetSamplerDestroyed()

◆ _descriptorSetTexture2Created()

◆ _descriptorSetTexture2Destroyed()

◆ _descriptorSetTextureCreated()

◆ _descriptorSetTextureDestroyed()

◆ _descriptorSetUavCreated()

◆ _descriptorSetUavDestroyed()

◆ _dispatch()

◆ _endFrame()

◆ _endFrameOnce()

◆ _executeResourceTransition()

◆ _getCurrentRenderViewport()

◆ _getDefaultViewportMaterialScheme()

◆ _getFrameBufferDescMap()

◆ _getMainContext()

◆ _hlmsBlendblockCreated()

◆ _hlmsBlendblockDestroyed()

◆ _hlmsComputePipelineStateObjectCreated()

◆ _hlmsComputePipelineStateObjectDestroyed()

◆ _hlmsMacroblockCreated()

◆ _hlmsMacroblockDestroyed()

◆ _hlmsPipelineStateObjectCreated()

◆ _hlmsPipelineStateObjectDestroyed()

◆ _hlmsSamplerblockCreated()

◆ _hlmsSamplerblockDestroyed()

◆ _initialise()

◆ _makeRsProjectionMatrix()

◆ _oneTimeContextInitialization()

◆ _pauseFrame()

◆ _render() [1/5]

◆ _render() [2/5]

◆ _render() [3/5]

◆ _render() [4/5]

◆ _render() [5/5]

◆ _renderEmulated() [1/2]

◆ _renderEmulated() [2/2]

◆ _renderEmulatedNoBaseInstance() [1/2]

◆ _renderEmulatedNoBaseInstance() [2/2]

◆ _renderNoBaseInstance() [1/2]

◆ _renderNoBaseInstance() [2/2]

◆ _resetMetrics()

◆ _resourceTransitionCreated()

◆ _resourceTransitionDestroyed()

◆ _resumeFrame()

◆ _setBindingType()

◆ _setComputePso()

◆ _setCurrentDeviceFromTexture()

◆ _setDepthBias()

◆ _setGeometryTexture()

◆ _setHlmsBlendblock()

◆ _setHlmsMacroblock()

◆ _setHlmsSamplerblock()

◆ _setIndirectBuffer()

◆ _setPipelineStateObject()

◆ _setPointParameters()

◆ _setPointSpritesEnabled()

◆ _setProjectionMatrix()

◆ _setRenderOperation()

◆ _setSamplers()

◆ _setSamplersCS()

◆ _setSceneBlending()

◆ _setSceneBlendingOperation()