Classes | |
| struct | _cpl_framedata_ |
| The public frame data object. More... | |
Typedefs | |
| typedef _cpl_framedata_ | cpl_framedata |
| The frame data object type. | |
Functions | |
| cpl_framedata * | cpl_framedata_new (void) |
| Create an new frame data object. | |
| cpl_framedata * | cpl_framedata_create (const char *tag, int min_count, int max_count) |
| Create a new frame data object and initialize it with the given values. | |
| cpl_framedata * | cpl_framedata_duplicate (const cpl_framedata *other) |
| Create a duplicate of another frame data object. | |
| void | cpl_framedata_clear (cpl_framedata *self) |
| Clear a frame data object. | |
| void | cpl_framedata_delete (cpl_framedata *self) |
| Delete a frame data object. | |
| const char * | cpl_framedata_get_tag (const cpl_framedata *self) |
| Get the frame tag. | |
| int | cpl_framedata_get_min_count (const cpl_framedata *self) |
| Get the minimum number of frames. | |
| int | cpl_framedata_get_max_count (const cpl_framedata *self) |
| Get the maximum number of frames. | |
| cpl_error_code | cpl_framedata_set_tag (cpl_framedata *self, const char *tag) |
| Set the frame tag to the given value. | |
| cpl_error_code | cpl_framedata_set_min_count (cpl_framedata *self, int min_count) |
| Set the minimum number of frames. | |
| cpl_error_code | cpl_framedata_set_max_count (cpl_framedata *self, int max_count) |
| Set the maximum number of frames. | |
| cpl_error_code | cpl_framedata_set (cpl_framedata *self, const char *tag, int min_count, int max_count) |
| Assign new values to a frame data object. | |
This module implements a frame data object, which stores auxiliary information of input and output frames of recipes. This information is used to store the frame configurations of recipes which can be queried by an application which is going to invoke the recipe.
The objects stores a frame tag, a unique identifier for a certain kind of frame, the minimum and maximum number of frames needed.
A frame is required if the data member min_count is set to a value greater than 0. The minimum and maximum number of frames is unspecified if the respective member, min_count or max_count, is set to -1.
The data members of this structure are public to allow for a static initialization. Any other access of the data members should still be done using the member functions.
#include <cpl_framedata.h>
|
|
The frame data object type.
|
|
|
Clear a frame data object.
|
|
||||||||||||||||
|
Create a new frame data object and initialize it with the given values.
|
|
|
Delete a frame data object.
|
|
|
Create a duplicate of another frame data object.
The function creates a clone of the given frame data object other. The created copy does not share any resources with the original object. |
|
|
Get the maximum number of frames.
The function returns the maximum number of frames value stored in self. If the returned value is |
|
|
Get the minimum number of frames.
The function returns the minimum number of frames value stored in self. If the returned value is |
|
|
Get the frame tag.
The function returns a handle to the frame tag stored in the frame data object self. |
|
|
Create an new frame data object.
NULL, and both, min_count and max_count are set to -1. |
|
||||||||||||||||||||
|
Assign new values to a frame data object.
The function updates the frame data object self with the given values for tag, min_count, and max_count. All previous values stored in self are replaced. The string tag is assigned by copying its contents.
|
|
||||||||||||
|
Set the maximum number of frames.
The function sets the maximum number of frames value of self to max_count. If max_count is |
|
||||||||||||
|
Set the minimum number of frames.
The function sets the minimum number of frames value of self to min_count. If min_count is |
|
||||||||||||
|
Set the frame tag to the given value.
The function assigns the string tag to the corresponding data member of the frame data object self by copying its contents. Any previous tag stored in self is replaced. |
1.4.6