Class PostFxVolume

A special type of volume that blends custom set of post process settings into the rendering.

Inheritance

Object

ScriptingObject

SceneObject

Actor

BoxVolume

PostFxVolume

Inherited Members

BoxVolume::_bounds

Actor::_box

Actor::_drawCategory

Actor::_drawNoCulling

ScriptingObject::_gcHandle

ScriptingObject::_id

Actor::_isActive

Actor::_isActiveInHierarchy

Actor::_isEnabled

Actor::_isHierarchyDirty

Actor::_isPrefabRoot

Actor::_layer

Actor::_localTransform

Actor::_name

SceneObject::_parent

Actor::_physicsScene

SceneObject::_prefabID

SceneObject::_prefabObjectID

Actor::_scene

BoxVolume::_size

Actor::_sphere

Actor::_staticFlags

Actor::_transform

ScriptingObject::_type

Actor::AddMovement(const Vector3& translation)

Actor::AddMovement(const Vector3& translation, const Quaternion& rotation)

Actor::AddScript()

Actor::AddStaticFlags(StaticFlags flags)

Actor::AddTag(const Tag& tag)

Actor::AddTagRecursive(const Tag& tag)

PostFxVolume

Actor::BeginPlay(SceneBeginData* data)

Actor::BreakPrefabLink()

ScriptingObject::CanCast(const ScriptingTypeHandle& from, const ScriptingTypeHandle& to)

ScriptingObject::CanCast(const MClass* from, const MClass* to)

ScriptingObject::Cast(ScriptingObject* obj)

ScriptingObject::ChangeID(const Guid& newId)

Actor::ChangeScriptOrder(Script* script, int32 newIndex)

Actor::Children

Actor::Clone()

ScriptingObject::CreateManaged()

ScriptingObject::CreateManagedInternal()

ScriptingObject::Deleted

Object::DeleteObject(float timeToLive = 0.0f, bool useGameTime=false)

Object::DeleteObjectNow()

Actor::DEPRECATED("Use HasTag instead") const String& GetTag()

Actor::DEPRECATED("Use AddTag instead") void SetTag(const StringView& value)

ISerializable::DeserializeIfExists(DeserializeStream& stream, const char* memberName, ISerializeModifier* modifier)

PostFxVolume

Actor::DestroyChildren(float timeLeft = 0.0f)

ScriptingObject::DestroyManaged()

Actor::Draw(RenderContext& renderContext)

Actor::Draw(RenderContextBatch& renderContextBatch)

Actor::EndPlay()

Actor::FindActor(const StringView& name)

Actor::FindActor(const MClass* type, bool activeOnly=false)

Actor::FindActor(const MClass* type, const StringView& name)

Actor::FindActor(const MClass* type, const Tag& tag, bool activeOnly=false)

Actor::FindActor()

Actor::FindActor(const Tag& tag)

Actor::FindScript(const MClass* type)

Actor::FindScript()

Object::Flags

Actor::FromBytes(const Span<byte>& data, Array<Actor* >& output, ISerializeModifier* modifier)

Actor::FromBytes(const Span<byte>& data)

Actor::FromBytes(const Span<byte>& data, const Dictionary<Guid, Guid, HeapAllocation>& idsMapping)

ScriptingObject::FromInterface(void* interfaceObj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::FromInterface(T* interfaceObj)

Actor::FromJson(const StringAnsiView& json)

Actor::GetBox()

Actor::GetBoxWithChildren()

Actor::GetChild(int32 index)

Actor::GetChild(const StringView& name)

Actor::GetChild(const MClass* type)

Actor::GetChild()

Actor::GetChildren(const MClass* type)

Actor::GetChildren()

Actor::GetChildrenCount()

ScriptingObject::GetClass()

Actor::GetDirection()

Actor::GetEditorBox()

Actor::GetEditorBoxChildren()

ScriptingObject::GetID()

Actor::GetIsActive()

Actor::GetLayer()

Actor::GetLayerMask()

Actor::GetLayerName()

Actor::GetLocalOrientation()

Actor::GetLocalPosition()

Actor::GetLocalScale()

Actor::GetLocalToWorldMatrix(Matrix& localToWorld)

Actor::GetLocalToWorldMatrix(Double4x4& localToWorld)

Actor::GetLocalTransform()

ScriptingObject::GetManagedInstance()

Actor::GetName()

SceneObject::GetNamePath(Char separatorChar='/')

Actor::GetOrAddChild()

ScriptingObject::GetOrCreateManagedInstance()

Actor::GetOrderInParent()

Actor::GetOrientation()

BoxVolume::GetOrientedBox()

SceneObject::GetParent()

Actor::GetPerInstanceRandom()

Actor::GetPhysicsScene()

Actor::GetPosition()

SceneObject::GetPrefabID()

SceneObject::GetPrefabObjectID()

Actor::GetPrefabRoot()

Actor::GetRotation()

Actor::GetScale()

Actor::GetScene()

Actor::GetSceneObjectId()

Actor::GetSceneRendering()

Actor::GetScript(int32 index)

Actor::GetScript(const MClass* type)

Actor::GetScript()

Actor::GetScriptByID(const Guid& id)

Actor::GetScripts(const MClass* type)

Actor::GetScripts()

Actor::GetScriptsCount()

BoxVolume::GetSize()

Actor::GetSphere()

Actor::GetStaticFlags()

Actor::GetTransform()

ScriptingObject::GetType()

ScriptingObject::GetTypeHandle()

Actor::GetWorldToLocalMatrix(Matrix& worldToLocal)

Actor::GetWorldToLocalMatrix(Double4x4& worldToLocal)

Actor::HasActorInChildren(Actor* a)

Actor::HasActorInHierarchy(Actor* a)

ScriptingObject::HasManagedInstance()

SceneObject::HasParent()

SceneObject::HasPrefabLink()

Actor::HasScene()

Actor::HasStaticFlag(StaticFlags flag)

Actor::HasTag()

Actor::HasTag(const Tag& tag)

Actor::HasTag(const StringView& tag)

Actor::HideFlags

Actor::Initialize()

Actor::InitializeHierarchy()

Actor::Intersects(const Ray& ray, Real& distance, Vector3& normal)

Actor::IntersectsItself(const Ray& ray, Real& distance, Vector3& normal)

ScriptingObject::Is(const ScriptingTypeHandle& type)

ScriptingObject::Is(const MClass* type)

ScriptingObject::Is()

Actor::IsActiveInHierarchy()

SceneObject::IsDuringPlay()

Actor::IsPrefabRoot()

ScriptingObject::IsRegistered()

Actor::IsStatic()

Actor::IsTransformStatic()

Actor::LinkPrefab(const Guid& prefabId, const Guid& prefabObjectId)

Actor::LookAt(const Vector3& worldPos)

Actor::LookAt(const Vector3& worldPos, const Vector3& worldUp)

Actor::LookingAt(const Vector3& worldPos)

Actor::LookingAt(const Vector3& worldPos, const Vector3& worldUp)

ScriptingObject::NewObject(const ScriptingTypeHandle& typeHandle)

ScriptingObject::NewObject()

Actor::OnActiveChanged()

Actor::OnActiveInTreeChanged()

Actor::OnBeginPlay()

BoxVolume::OnBoundsChanged(const BoundingBox& prevBounds)

BoxVolume::OnDebugDraw()

BoxVolume::OnDebugDrawSelected()

Actor::OnDeleteObject()

Actor::OnEndPlay()

Actor::OnLayerChanged()

ScriptingObject::OnManagedInstanceDeleted()

Actor::OnOrderInParentChanged()

Actor::OnParentChanged()

Actor::OnPhysicsSceneChanged(PhysicsScene* previous)

ScriptingObject::OnScriptingDispose()

Actor::OnStaticFlagsChanged()

BoxVolume::OnTransformChanged()

ScriptingObject::RegisterObject()

Actor::RemoveStaticFlags(StaticFlags flags)

Actor::RemoveTag(const Tag& tag)

Actor::ResetLocalTransform()

SceneObject::SceneObject(const SpawnParams& params)

ScriptingObject::ScriptingObject(const SpawnParams& params)

Actor::Scripts

PostFxVolume

PostFxVolume

Actor::SetDirection(const Float3& value)

Actor::SetIsActive(bool value)

Actor::SetLayer(int32 layerIndex)

Actor::SetLayerName(const StringView& value)

Actor::SetLayerNameRecursive(const StringView& value)

Actor::SetLayerRecursive(int32 layerIndex)

Actor::SetLocalOrientation(const Quaternion& value)

Actor::SetLocalPosition(const Vector3& value)

Actor::SetLocalScale(const Float3& value)

Actor::SetLocalTransform(const Transform& value)

ScriptingObject::SetManagedInstance(MObject* instance)

Actor::SetName(String&& value)

Actor::SetName(const StringView& value)

Actor::SetOrderInParent(int32 index)

Actor::SetOrientation(const Quaternion& value)

Actor::SetParent(Actor* value, bool worldPositionsStays, bool canBreakPrefabLink)

Actor::SetParent(Actor* value, bool canBreakPrefabLink=true)

SceneObject::SetParent(Actor* value)

Actor::SetPhysicsScene(PhysicsScene* scene)

Actor::SetPosition(const Vector3& value)

Actor::SetRotation(const Matrix& value)

Actor::SetScale(const Float3& value)

BoxVolume::SetSize(const Vector3& value)

Actor::SetStaticFlag(StaticFlags flag, bool value)

Actor::SetStaticFlags(StaticFlags value)

Actor::SetTransform(const Transform& value)

PostFxVolume

Actor::Tags

Actor::ToBytes(const Array<Actor* >& actors, MemoryWriteStream& output)

Actor::ToBytes(const Array<Actor* >& actors)

ScriptingObject::ToInterface(ScriptingObject* obj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::ToInterface(ScriptingObject* obj)

Actor::ToJson()

ScriptingObject::ToManaged(const ScriptingObject* obj)

ScriptingObject::ToNative(MObject* obj)

Actor::ToString()

Actor::TreeExecute(Function<bool(Actor* , Params ...)>& action, Params ... args)

Actor::TreeExecuteChildren(Function<bool(Actor* , Params ...)>& action, Params ... args)

Actor::TryGetSerializedObjectsIds(const Span<byte>& data)

ScriptingObject::UnregisterObject()

Actor::UnregisterObjectHierarchy()

ISerializable::~ISerializable()

Object::~Object()

SceneObject::~SceneObject()

ScriptingObject::~ScriptingObject()

Assembly: FlaxEngine.dll

File: Engine/Level/Actors/PostFxVolume.h

Syntax

public class PostFxVolume : public BoxVolume, public IPostFxSettingsProvider

Fields

AmbientOcclusion

The ambient occlusion effect settings.

Declaration

public AmbientOcclusionSettings AmbientOcclusion

Field Value

AmbientOcclusionSettings

AntiAliasing

The anti-aliasing effect settings.

Declaration

public AntiAliasingSettings AntiAliasing

Field Value

AntiAliasingSettings

Bloom

The bloom effect settings.

Declaration

public BloomSettings Bloom

Field Value

BloomSettings

CameraArtifacts

The camera artifacts effect settings.

Declaration

public CameraArtifactsSettings CameraArtifacts

Field Value

CameraArtifactsSettings

ColorGrading

The color grading effect settings.

Declaration

public ColorGradingSettings ColorGrading

Field Value

ColorGradingSettings

DepthOfField

The depth of field effect settings.

Declaration

public DepthOfFieldSettings DepthOfField

Field Value

DepthOfFieldSettings

EyeAdaptation

The eye adaptation effect settings.

Declaration

public EyeAdaptationSettings EyeAdaptation

Field Value

EyeAdaptationSettings

GlobalIllumination

The Global Illumination effect settings.

Declaration

public GlobalIlluminationSettings GlobalIllumination

Field Value

GlobalIlluminationSettings

LensFlares

The lens flares effect settings.

Declaration

public LensFlaresSettings LensFlares

Field Value

LensFlaresSettings

MotionBlur

The motion blur effect settings.

Declaration

public MotionBlurSettings MotionBlur

Field Value

MotionBlurSettings

PostFxMaterials

The PostFx materials rendering settings.

Declaration

public PostFxMaterialsSettings PostFxMaterials

Field Value

PostFxMaterialsSettings

ScreenSpaceReflections

The screen space reflections effect settings.

Declaration

public ScreenSpaceReflectionsSettings ScreenSpaceReflections

Field Value

ScreenSpaceReflectionsSettings

ToneMapping

The tone mapping effect settings.

Declaration

public ToneMappingSettings ToneMapping

Field Value

ToneMappingSettings

Methods

AddPostFxMaterial(MaterialBase* material)

Adds the post fx material to the settings.

Declaration

public void AddPostFxMaterial(MaterialBase* material)

Parameters

MaterialBase material The material.

Blend(PostProcessSettings& other, float weight)

Blends the object settings to the given settings using given weight.

Declaration

public virtual void Blend(PostProcessSettings& other, float weight) override

Parameters

PostProcessSettings other The other settings to blend to.

float weight The blending weight (normalized to 0-1 range).

Overrides

IPostFxSettingsProvider::Blend(PostProcessSettings& other, float weight)

Collect(RenderContext& renderContext)

Collects the settings for rendering of the specified task.

Declaration

public virtual void Collect(RenderContext& renderContext) override

Parameters

RenderContext renderContext The rendering context.

Overrides

IPostFxSettingsProvider::Collect(RenderContext& renderContext)

Deserialize(DeserializeStream& stream, ISerializeModifier* modifier)

Deserializes object from the input stream.

Declaration

public virtual void Deserialize(DeserializeStream& stream, ISerializeModifier* modifier) override

Parameters

DeserializeStream stream The input stream.

ISerializeModifier modifier The deserialization modifier object. Always valid.

Overrides

BoxVolume::Deserialize(DeserializeStream& stream, ISerializeModifier* modifier)

GetBlendRadius()

Gets the distance inside the volume at which blending with the volume's settings occurs.

Declaration

public float GetBlendRadius() const

Returns

float

GetBlendWeight()

Gets the amount of influence the volume's properties have. 0 is no effect; 1 is full effect.

Declaration

public float GetBlendWeight() const

Returns

float

GetIsBounded()

Gets the value indicating whether the bounds of the volume are taken into account. If false, the volume affects the entire world, regardless of its bounds. If true, the volume only has an effect within its bounds.

Declaration

public bool GetIsBounded() const

Returns

bool

GetPriority()

Gets the order in which multiple volumes are blended together. The volume with the highest priority takes precedence over all other overlapping volumes.

Declaration

public int32 GetPriority() const

Returns

int32

GetWiresColor()

Declaration

protected virtual Color GetWiresColor() override

Returns

Color

Overrides

BoxVolume::GetWiresColor()

HasContentLoaded()

Returns true if actor has loaded content.

Declaration

public virtual bool HasContentLoaded() const override

Returns

bool

Overrides

Actor::HasContentLoaded()

OnDisable()

Called when actor gets removed from game systems. Occurs on EndPlay event or when actor gets inactivated in hierarchy. Use this event to unregister object from other game system (eg. audio).

Declaration

protected virtual void OnDisable() override

Overrides

Actor::OnDisable()

OnEnable()

Called when actor gets added to game systems. Occurs on BeginPlay event or when actor gets activated in hierarchy. Use this event to register object to other game system (eg. audio).

Declaration

protected virtual void OnEnable() override

Overrides

Actor::OnEnable()

RemovePostFxMaterial(MaterialBase* material)

Removes the post fx material from the settings.

Declaration

public void RemovePostFxMaterial(MaterialBase* material)

Parameters

MaterialBase material The material.

Serialize(SerializeStream& stream, const void* otherObj)

Serializes object to the output stream compared to the values of the other object instance (eg. default class object). If other object is null then serialize all properties.

Declaration

public virtual void Serialize(SerializeStream& stream, const void* otherObj) override

Parameters

SerializeStream stream The output stream.

void otherObj The instance of the object to compare with and serialize only the modified properties. If null, then serialize all properties.

Overrides

BoxVolume::Serialize(SerializeStream& stream, const void* otherObj)

SetBlendRadius(float value)

Sets the distance inside the volume at which blending with the volume's settings occurs.

Declaration

public void SetBlendRadius(float value)

Parameters

float value

SetBlendWeight(float value)

Sets the amount of influence the volume's properties have. 0 is no effect; 1 is full effect.

Declaration

public void SetBlendWeight(float value)

Parameters

float value

SetIsBounded(bool value)

Sets the value indicating whether the bounds of the volume are taken into account. If false, the volume affects the entire world, regardless of its bounds. If true, the volume only has an effect within its bounds.

Declaration

public void SetIsBounded(bool value)

Parameters

bool value

Returns

void

SetPriority(int32 value)

Sets the order in which multiple volumes are blended together. The volume with the highest priority takes precedence over all other overlapping volumes.

Declaration

public void SetPriority(int32 value)

Parameters

int32 value

Returns

void