PostEffect

References
public abstract class PostEffect : IDisposable

Constructors

PostEffect

#Since v7.0
public PostEffect()

Finalizer

~PostEffect

#
~PostEffect()

Properties

CanDisplayHelp

#Since v7.0
public bool CanDisplayHelp { get; }

ExecuteWhileRenderingOption

#Since v7.0
public PostEffectExecuteWhileRenderingOptions ExecuteWhileRenderingOption { get; }

Id

#Since v7.0
public Guid Id { get; }

IsSelected

#Since v7.0
Return true if the post effect is selected.
public bool IsSelected { get; }

LocalName

#Since v7.0
public string LocalName { get; }

On

#Since v7.0
public bool On { get; set; }

PostEffectType

#Since v7.0
public PostEffectType PostEffectType { get; }

RequiredChannels

#Since v7.0
The RDK calls this method to determine which channels a post effect requires. If a required channel is not available, the RDK will hide the post effect's UI and display explanatory text instead. Note: As a convenience, the default implementation adds IRhRdkRenderWindow::chanRGBA to the output array. Most post effects should be able to use this default with no need to override the method.
public virtual Guid[] RequiredChannels { get; }
The channel Ids.The post effect should return all channels used by its implementation to this array.

SerialNumber

#Since v7.0
public int SerialNumber { get; set; }

Shown

#Since v7.0
public bool Shown { get; set; }

Styles

#Since v7.0
public PostEffectStyles Styles { get; }

Methods

AddUISections

#Since v7.0
Create each of your UI sections using 'new' and then call ui.AddSection() on them. RDK takes ownership of the sections.If your post effect does not need a UI, then your implementation of this method can be a no-op.
public abstract void AddUISections(
ui
PostEffectUI
)

BeginChange

#Since v7.0
public void BeginChange(
changeContext
)

CanExecute

#Since v7.0
Return true if the post effect can execute, else false. The base implementation checks if the post effect is 'On' and 'Shown'. Post effect authors can override this to include other criteria but cannot disable the base criteria.
public virtual bool CanExecute(
pipeline
PostEffectPipeline
)
Return true if the post effect can execute, else false

Changed

#Since v7.0
public void Changed()

DisplayHelp

#Since v7.0
Displays the post effect's help page, if any.
public abstract bool DisplayHelp()
Return true if successful, else false.

Dispose

#Since v7.0
public void Dispose()

Dispose

#Since v7.0
public virtual void Dispose(
bDisposing
)

EndChange

#Since v7.0
public bool EndChange()

Execute

#Since v7.0
Execute the post effect.
public abstract bool Execute(
pipeline,
pipeline provides access to the post-effect pipeline.
rect
rect is the pixel area to process.
)
Return true if successful, else false.

GetHashCode

#Since v7.0
A CRC of the state of this post effect.
public override int GetHashCode()
returns a crc of post effect state

GetParam

#Since v7.0
Get a parameter.
public abstract bool GetParam(
param,
is the name of the parameter to get.
ref object
v
accepts the parameter value.
)
Returns true if successful or false if the parameter was not found.

ReadFromDocumentDefaults

#Since v7.0 Obsolete v8.0
Because post effects are now in the render settings, this function can no longer be called.
public virtual bool ReadFromDocumentDefaults()
obsoleteThis function is no longer called

ReadState

#Since v7.0
Read the state. If your post effect has no state, you must still return true for success.
public abstract bool ReadState(
state
PostEffectState
)
Return true if successful, else false.

RegisterPostEffect

#Since v7.0
public static Type[] RegisterPostEffect(
assembly,
pluginId
)

RegisterPostEffect

#Since v7.0
public static Type[] RegisterPostEffect(
plugin
)

ResetToFactoryDefaults

#Since v7.0
Reset the state to factory defaults.
public abstract void ResetToFactoryDefaults()

SetParam

#Since v7.0
Set a parameter.
public abstract bool SetParam(
param,
is the name of the parameter to set.
v
specifies the type and value to set.
)
Return true if successful or false if the parameter could not be set.

WriteState

#Since v7.0
Write the state. If your post effect has no state, you must still return true for success.
public abstract bool WriteState(
state
PostEffectState
)
Return true if successful, else false.

WriteToDocumentDefaults

#Since v7.0 Obsolete v8.0
Because post effects are now in the render settings, this function can no longer be called.
public virtual bool WriteToDocumentDefaults()
obsoleteThis function is no longer called