An effects implementation that can consume video frame images and render output.
More...
#include <effects.h>
Inherited by WebVfx::EffectsImpl.
An effects implementation that can consume video frame images and render output.
Instances of this class are created with WebVfx::createEffects() and can be accessed from any thread, but the class is not threadsafe so access should be synchronized.
Describes the type of an image.
| Enumerator |
|---|
| SourceImageType |
The source (origin/from) image in a transition, or the image being processed in a filter.
|
| TargetImageType |
The target (destination/to) image in a transition.
|
| ExtraImageType |
An extra image not directly participating in a filter or transition.
|
| virtual const ImageTypeMap& WebVfx::Effects::getImageTypeMap |
( |
| ) |
|
|
pure virtual |
Describes the image names this effect will request.
Images for these names will need to be set using setImage() each time before render() is called.
- Returns
- a map mapping image names to their ImageType
| virtual bool WebVfx::Effects::render |
( |
double |
time, |
|
|
Image * |
renderImage |
|
) |
| |
|
pure virtual |
Renders the effect for the given time.
Prior to calling render() each time, all named images must be set via setImage().
- Parameters
-
| time | Time to render image for, must be from 0 to 1.0. |
| renderImage | Image buffer to render into. |
| virtual void WebVfx::Effects::renderComplete |
( |
bool |
result | ) |
|
|
pure virtual |
Indicate that rendering is done.
- Parameters
-
| result | This is the success/fail value to return from render(). |
| virtual void WebVfx::Effects::setImage |
( |
const QString & |
name, |
|
|
Image * |
image |
|
) |
| |
|
pure virtual |
Set an Image for the given name.
- Parameters
-
| name | Name of the image |
| image | Image data. The Image pixels must remain valid until render() is called. |
The documentation for this class was generated from the following files:
- webvfx/effects.h
- webvfx/effects.cpp
