OGRE-Next
2.3
Object-Oriented Graphics Rendering Engine
|
Per-Pixel reflection probes. More...
#include <OgreParallaxCorrectedCubemapAuto.h>
Public Member Functions | |
ParallaxCorrectedCubemapAuto (IdType id, Root *root, SceneManager *sceneManager, const CompositorWorkspaceDef *probeWorkspaceDef) | |
~ParallaxCorrectedCubemapAuto () | |
virtual TextureGpu * | _acquireTextureSlot (uint16 &outTexSlot) |
Acquires a texture with a given slot. More... | |
virtual void | _addManuallyActiveProbe (CubemapProbe *probe) |
virtual void | _copyRenderTargetToCubemap (uint32 cubemapArrayIdx) |
virtual void | _notifyPreparePassHash (const Matrix4 &viewMatrix) |
virtual void | _releaseManualHardwareResources () |
virtual void | _releaseTextureSlot (TextureGpu *texture, uint32 texSlot) |
virtual void | _removeManuallyActiveProbe (CubemapProbe *probe) |
virtual void | _restoreManualHardwareResources () |
void | _setIsRendering (bool bIsRendering) |
void | _setProbeRenderInProgress (CubemapProbe *probe) |
virtual void | allWorkspacesBeforeBeginUpdate () |
Called from CompositorManager2 (not CompositorWorkspace) when we're about to begin updating all the workspaces. More... | |
virtual void | allWorkspacesBeginUpdate () |
Called from CompositorManager2 (not CompositorWorkspace) when we're about to update all the workspaces (it's safe to update your own workspaces without calling _beginUpdate and _endUpdate) Warning: Don't add/remove listeners to CompositorManager2 inside this function. More... | |
CubemapProbe * | createProbe () |
Adds a cubemap probe. More... | |
virtual void | destroyAllProbes () |
virtual void | destroyProbe (CubemapProbe *probe) |
virtual void | eventOccurred (const String &eventName, const NameValuePairList *parameters) |
A rendersystem-specific event occurred. More... | |
virtual void | fillConstBufferData (const Matrix4 &viewMatrix, float *RESTRICT_ALIAS passBufferPtr) const |
virtual TextureGpu * | findIbl (const TextureGpu *baseParams) |
virtual TextureGpu * | findTmpRtt (const TextureGpu *baseParams) |
See mTmpRtt. More... | |
virtual bool | frameEnded (const FrameEvent &evt) |
Called just after a frame has been rendered. More... | |
virtual bool | frameRenderingQueued (const FrameEvent &evt) |
Called after all render targets have had their rendering commands issued, but before render windows have been asked to flip their buffers over. More... | |
virtual bool | frameStarted (const FrameEvent &evt) |
Called when a frame is about to begin rendering. More... | |
bool | getAutomaticMode () const |
TextureGpu * | getBindTexture () const |
const HlmsSamplerblock * | getBindTrilinearSamplerblock () |
virtual size_t | getConstBufferSize () |
const CompositorWorkspaceDef * | getDefaultWorkspaceDef () const |
bool | getEnabled () const |
uint32 | getIblTargetTextureFlags (PixelFormatGpu pixelFormat) const |
IdType | getId () const |
Get the unique id of this object. More... | |
ParallaxCorrectedCubemapAutoListener * | getListener () const |
const CubemapProbeVec & | getProbes () const |
SceneManager * | getSceneManager () const |
bool | getUseDpm2DArray () const |
bool | isRendering () const |
Inform whether we're currently updating a probe. More... | |
bool | operator() (const IdObject &left, const IdObject &right) |
bool | operator() (const IdObject *left, const IdObject *right) |
virtual void | passEarlyPreExecute (CompositorPass *pass) |
Called early on in pass' execution. More... | |
virtual void | passPosExecute (CompositorPass *pass) |
Called after a pass has been executed. More... | |
virtual void | passPreExecute (CompositorPass *pass) |
Called when each pass is about to be executed. More... | |
virtual void | passSceneAfterFrustumCulling (CompositorPassScene *pass) |
Called after a pass scene has performed frustum caulling but has yet to prepare and execute rendering commands. More... | |
virtual void | passSceneAfterShadowMaps (CompositorPassScene *pass) |
Called after a pass scene has rendered shadow casting (it gets called even if there is no shadow node). More... | |
virtual void | prepareForClearScene () |
Destroys the Proxy Items. More... | |
virtual void | releaseIbl (const TextureGpu *tmpRtt) |
virtual void | releaseTmpRtt (const TextureGpu *tmpRtt) |
virtual void | restoreFromClearScene () |
void | setEnabled (bool bEnabled, uint32 width, uint32 height, uint32 maxNumProbes, PixelFormatGpu pixelFormat) |
Enables/disables this ParallaxCorrectedCubemapAuto system. More... | |
void | setListener (ParallaxCorrectedCubemapAutoListener *listener) |
void | setUpdatedTrackedDataFromCamera (Camera *trackedCamera) |
Will update both mTrackedPosition with appropiate settings every time it's called. More... | |
void | setUseDpm2DArray (bool useDpm2DArray) |
Whether we should use Dual Paraboloid Mapping with 2D Array instead of Cubemap Arrays. More... | |
void | updateAllDirtyProbes () |
By default the probes will be constructed when the user enters the vecinity of non-static probes, and whenever a static probe is dirty. More... | |
virtual void | workspacePosUpdate (CompositorWorkspace *workspace) |
Called after all nodes has been updated. More... | |
virtual void | workspacePreUpdate (CompositorWorkspace *workspace) |
Called before all nodes are going to be updated. More... | |
Static Public Member Functions | |
static void | fillConstBufferData (const CubemapProbe &probe, const Matrix4 &viewMatrix, const Matrix3 &invViewMat3, float *RESTRICT_ALIAS passBufferPtr) |
static uint8 | getIblNumMipmaps (uint32 width, uint32 height) |
Public Attributes | |
uint32 | mMask |
bool | mPaused |
Vector3 | mTrackedPosition |
This variable should be updated every frame and often represents the camera position, but it can also be used set to other things like the player's character position. More... | |
Per-Pixel reflection probes.
Per-Pixel reflection probes are much easier to handle, they're more flexible and powerful. However they require a modern GPU with Cubemap Arrays. Forward Clustered also must be active.
ParallaxCorrectedCubemapAuto supports having more CubemapProbes than the maximum number of probes you pass to ParallaxCorrectedCubemapAuto::setEnabled. However only 'maxNumProbes' probes can be active at the same time. This is all done thanks to _acquireTextureSlot & _releaseTextureSlot.
To activate a probe, call CubemapProbe::initWorkspace. To deactivate it, call CubemapProbe::destroyWorkspace.
Ogre::ParallaxCorrectedCubemapAuto::ParallaxCorrectedCubemapAuto | ( | IdType | id, |
Root * | root, | ||
SceneManager * | sceneManager, | ||
const CompositorWorkspaceDef * | probeWorkspaceDef | ||
) |
Ogre::ParallaxCorrectedCubemapAuto::~ParallaxCorrectedCubemapAuto | ( | ) |
|
virtual |
Acquires a texture with a given slot.
outTexSlot | [out] Texture slot. Value is left untouched if return value is nullptr |
Reimplemented from Ogre::ParallaxCorrectedCubemapBase.
|
virtualinherited |
Reimplemented in Ogre::ParallaxCorrectedCubemap.
|
virtual |
Reimplemented from Ogre::ParallaxCorrectedCubemapBase.
|
virtualinherited |
Reimplemented in Ogre::ParallaxCorrectedCubemap.
|
virtualinherited |
Reimplemented in Ogre::ParallaxCorrectedCubemap.
|
virtual |
Reimplemented from Ogre::ParallaxCorrectedCubemapBase.
|
virtualinherited |
Reimplemented in Ogre::ParallaxCorrectedCubemap.
|
virtualinherited |
Reimplemented in Ogre::ParallaxCorrectedCubemap.
|
inlineinherited |
|
inlineinherited |
|
virtual |
Called from CompositorManager2 (not CompositorWorkspace) when we're about to begin updating all the workspaces.
You'll have to manage the RenderSystem and SceneManager to call the adequate begin/end calls Warning: Don't add/remove listeners to CompositorManager2 inside this function.
Reimplemented from Ogre::CompositorWorkspaceListener.
|
virtual |
Called from CompositorManager2 (not CompositorWorkspace) when we're about to update all the workspaces (it's safe to update your own workspaces without calling _beginUpdate and _endUpdate) Warning: Don't add/remove listeners to CompositorManager2 inside this function.
Reimplemented from Ogre::CompositorWorkspaceListener.
|
inherited |
Adds a cubemap probe.
|
virtualinherited |
Reimplemented in Ogre::ParallaxCorrectedCubemap.
|
virtual |
Reimplemented from Ogre::ParallaxCorrectedCubemapBase.
|
virtualinherited |
A rendersystem-specific event occurred.
eventName | The name of the event which has occurred |
parameters | A list of parameters that may belong to this event, may be null if there are no parameters |
Implements Ogre::RenderSystem::Listener.
|
staticinherited |
|
virtualinherited |
Reimplemented in Ogre::ParallaxCorrectedCubemap.
|
virtual |
Reimplemented from Ogre::ParallaxCorrectedCubemapBase.
|
virtual |
See mTmpRtt.
Finds an RTT that is compatible to copy to baseParams. Creates one if none found.
Reimplemented from Ogre::ParallaxCorrectedCubemapBase.
|
inlinevirtualinherited |
Called just after a frame has been rendered.
Reimplemented in Ogre::FrameTimeControllerValue.
|
inlinevirtualinherited |
Called after all render targets have had their rendering commands issued, but before render windows have been asked to flip their buffers over.
|
virtual |
Called when a frame is about to begin rendering.
Reimplemented from Ogre::FrameListener.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
virtualinherited |
Reimplemented in Ogre::ParallaxCorrectedCubemap.
|
inherited |
bool Ogre::ParallaxCorrectedCubemapAuto::getEnabled | ( | ) | const |
|
staticinherited |
|
inherited |
|
inlineinherited |
Get the unique id of this object.
|
inline |
|
inlineinherited |
|
inherited |
|
inlineinherited |
|
inlineinherited |
Inform whether we're currently updating a probe.
Some Hlms / PCC combinations should not perform PCC while rendering, either because the RenderTarget is the same as the cubemap texture, or because other glitches may occur
|
inlinevirtualinherited |
Called early on in pass' execution.
Happens before passPreExecute, before the pass has set anything. Warning: calling pass->execute can result in recursive calls.
|
inlinevirtualinherited |
Called after a pass has been executed.
Warning: calling pass->execute can result in recursive calls.
|
virtual |
Called when each pass is about to be executed.
Warning: calling pass->execute can result in recursive calls.
Reimplemented from Ogre::ParallaxCorrectedCubemapBase.
|
inlinevirtualinherited |
Called after a pass scene has performed frustum caulling but has yet to prepare and execute rendering commands.
Gets called after passSceneAfterFrustumCulling and before passPosExecute
Warning: calling pass->execute can result in recursive calls.
|
inlinevirtualinherited |
Called after a pass scene has rendered shadow casting (it gets called even if there is no shadow node).
Gets called after passPreExecute and before passSceneAfterFrustumCulling
Warning: calling pass->execute can result in recursive calls.
|
virtualinherited |
Destroys the Proxy Items.
Useful if you need to call sceneManager->clearScene(); The you MUST call this function before. i.e. pcc->prepareForClearScene(); sceneManager->clearScene(); pcc->restoreFromClearScene(); Updating ParallaxCorrectedCubemap without calling prepareForClearScene/restoreFromClearScene will result in a crash.
Reimplemented in Ogre::ParallaxCorrectedCubemap.
|
virtual |
Reimplemented from Ogre::ParallaxCorrectedCubemapBase.
|
virtual |
Reimplemented from Ogre::ParallaxCorrectedCubemapBase.
|
virtualinherited |
Reimplemented in Ogre::ParallaxCorrectedCubemap.
void Ogre::ParallaxCorrectedCubemapAuto::setEnabled | ( | bool | bEnabled, |
uint32 | width, | ||
uint32 | height, | ||
uint32 | maxNumProbes, | ||
PixelFormatGpu | pixelFormat | ||
) |
Enables/disables this ParallaxCorrectedCubemapAuto system.
It will (de)allocate some resources, thus it may cause stalls. If you need to temporarily pause the system (or toggle at high frequency) use mPaused instead (it's a public variable).
bEnabled | True to enable. False to disable. When false, the rest of the arguments are ignored. |
width | Unlike the manual system, in PCC Auto all probes must use the same resolution |
height | Unlike the manual system, in PCC Auto all probes must use the same resolution |
maxNumProbes | Max number of probes. Necessary. On AMD GCN cards, this should be a power of 2 otherwise the driver will internally round it up (and waste memory) |
pixelFormat | PixelFormatGpu for the cubemap |
|
inline |
void Ogre::ParallaxCorrectedCubemapAuto::setUpdatedTrackedDataFromCamera | ( | Camera * | trackedCamera | ) |
Will update both mTrackedPosition with appropiate settings every time it's called.
Must be called every time the camera changes.
This information is used to know which nearby non-static probes need to be updated every frame.
trackedCamera | Camera whose settings to use as reference. We will not keep a reference to this pointer. |
void Ogre::ParallaxCorrectedCubemapAuto::setUseDpm2DArray | ( | bool | useDpm2DArray | ) |
Whether we should use Dual Paraboloid Mapping with 2D Array instead of Cubemap Arrays.
When cubemap arrays are not supported, this setting is always forced on.
When cubemap arrays are supported, it's up to you. The most likely reason you want to use DPM overy cubemap arrays is to see how it looks like on unsupported platforms.
You cannot toggle this setting after enabling the system. You must call ParallaxCorrectedCubemapAuto::setEnabled( false, ... ); to switch this.
useDpm2DArray | True to use DPM, cubemap arrays otherwise. Default: False unless GPU does not support cubemap arrays |
|
virtual |
By default the probes will be constructed when the user enters the vecinity of non-static probes, and whenever a static probe is dirty.
This can cause noticeable stalls. Use this function to regenerate them all at once (i.e. at loading time) This function also uses a memory-friendly way of updating the probes.
Implements Ogre::ParallaxCorrectedCubemapBase.
|
inlinevirtualinherited |
Called after all nodes has been updated.
|
inlinevirtualinherited |
Called before all nodes are going to be updated.
Use this place to update your own, manually updated Workspaces without having to call @CompositorWorkspace::_beginUpdate( forceBeginFrame=true )
|
inherited |
|
inherited |
Vector3 Ogre::ParallaxCorrectedCubemapAuto::mTrackedPosition |
This variable should be updated every frame and often represents the camera position, but it can also be used set to other things like the player's character position.