OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::CompositorPassMipmapDef Class Reference

#include <OgreCompositorPassMipmapDef.h>

+ Inheritance diagram for Ogre::CompositorPassMipmapDef:

Public Types

enum  MipmapGenerationMethods { ApiDefault , Compute , ComputeHQ }
 
- Public Types inherited from Ogre::CompositorPassDef
typedef vector< UavDependency >::type UavDependencyVec
 

Public Member Functions

 CompositorPassMipmapDef (CompositorTargetDef *parentTargetDef)
 
- Public Member Functions inherited from Ogre::CompositorPassDef
 CompositorPassDef (CompositorPassType passType, CompositorTargetDef *parentTargetDef)
 
virtual ~CompositorPassDef ()
 
const CompositorTargetDefgetParentTargetDef () const
 
uint32 getRtIndex () const
 
CompositorPassType getType () const
 
void setAllClearColours (const ColourValue &clearValue)
 
void setAllLoadActions (LoadAction::LoadAction loadAction)
 
void setAllStoreActions (StoreAction::StoreAction storeAction)
 

Public Attributes

float mGaussianDeviationFactor
 Used when mMipmapGenerationMethod == ComputeHQ. More...
 
uint8 mKernelRadius
 Used when mMipmapGenerationMethod == ComputeHQ. More...
 
MipmapGenerationMethods mMipmapGenerationMethod
 
- Public Attributes inherited from Ogre::CompositorPassDef
ColourValue mClearColour [OGRE_MAX_MULTIPLE_RENDER_TARGETS]
 
float mClearDepth
 
uint32 mClearStencil
 
bool mColourWrite
 When false will not really bind the RenderTarget for rendering and use a null colour buffer instead. More...
 
uint8 mExecutionMask
 
IdStringVec mExposedTextures
 
bool mFlushCommandBuffers
 Whether to flush the command buffer at the end of the pass. More...
 
uint32 mIdentifier
 Custom value in case there's a listener attached (to identify the pass) More...
 
bool mIncludeOverlays
 TODO: Refactor OgreOverlay to remove this design atrocity. More...
 
LoadAction::LoadAction mLoadActionColour [OGRE_MAX_MULTIPLE_RENDER_TARGETS]
 
LoadAction::LoadAction mLoadActionDepth
 
LoadAction::LoadAction mLoadActionStencil
 
uint32 mNumInitialPasses
 Number of times to perform the pass before stopping. -1 to never stop. More...
 
uint32 mNumViewports
 
String mProfilingId
 
bool mReadOnlyDepth
 
bool mReadOnlyStencil
 
bool mShadowMapFullViewport
 Only used if mShadowMapIdx is valid (if pass is owned by Shadow Nodes). More...
 
uint32 mShadowMapIdx
 Shadow map index it belongs to (only filled in passes owned by Shadow Nodes) More...
 
bool mSkipLoadStoreSemantics
 Ignore mLoadAction*‍/mStoreAction*. More...
 
StoreAction::StoreAction mStoreActionColour [OGRE_MAX_MULTIPLE_RENDER_TARGETS]
 
StoreAction::StoreAction mStoreActionDepth
 
StoreAction::StoreAction mStoreActionStencil
 
UavDependencyVec mUavDependencies
 
uint8 mViewportModifierMask
 
ViewportRect mVpRect [16]
 Viewport's region to draw. More...
 
bool mWarnIfRtvWasFlushed
 Will issue a warning (by raising an exception) if Ogre is forced to flush the RenderTarget, which is very bad for performance on mobile, and can cause serious performance problems in Desktop if using MSAA, and also cause correctness problems (i.e. More...
 

Member Enumeration Documentation

◆ MipmapGenerationMethods

Enumerator
ApiDefault 

Use the default based on the API selected. On DX12 that means using Compute.

Compute 

Tell the API's to use high quality.

Not recommended ("quality" varies a lot across vendors). Use a compute shader. Ogre must be compiled with JSON and the Compute shaders bundled at Samples/Media/2.0/scripts/materials/Common must be in the resource path.

Remarks
Will use ApiDefault if Compute Shaders are not supported. At the time of writing (2017/01/16) Compute uses ComputeHQ
ComputeHQ 

See Compute, but use a high quality gaussian filter.

Constructor & Destructor Documentation

◆ CompositorPassMipmapDef()

Ogre::CompositorPassMipmapDef::CompositorPassMipmapDef ( CompositorTargetDef parentTargetDef)
inline

Member Data Documentation

◆ mGaussianDeviationFactor

float Ogre::CompositorPassMipmapDef::mGaussianDeviationFactor

Used when mMipmapGenerationMethod == ComputeHQ.

◆ mKernelRadius

uint8 Ogre::CompositorPassMipmapDef::mKernelRadius

Used when mMipmapGenerationMethod == ComputeHQ.

◆ mMipmapGenerationMethod

MipmapGenerationMethods Ogre::CompositorPassMipmapDef::mMipmapGenerationMethod

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