PostEffect
ReferencesConstructors
public PostEffect()
Finalizer
~PostEffect
#~PostEffect()
Properties
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.
Returns: The channel Ids.The post effect should return all channels used by its implementation to this array.
Methods
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.
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.
Returns: Return true if the post effect can execute, else false
public void Changed()
Displays the post effect's help page, if any.
Returns: Return true if successful, else false.
public void Dispose()
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.
Returns: Return true if successful, else false.
A CRC of the state of this post effect.
Returns: returns a crc of post effect state
Overrides: Object.GetHashCode
Get a parameter.
Returns: Returns true if successful or false if the parameter was not found.
Because post effects are now in the render settings, this function can no longer be called.
obsoleteThis function is no longer called
Read the state. If your post effect has no state, you must still return true for success.
Returns: Return true if successful, else false.
Reset the state to factory defaults.
public abstract void ResetToFactoryDefaults()
Set a parameter.
Returns: Return true if successful or false if the parameter could not be set.
Write the state. If your post effect has no state, you must still return true for success.
Returns: Return true if successful, else false.