Functions | |
unsigned int | cucul_get_canvas_frame_count (cucul_canvas_t *) |
Get the number of frames in a canvas. | |
int | cucul_set_canvas_frame (cucul_canvas_t *, unsigned int) |
Activate a given canvas frame. | |
int | cucul_create_canvas_frame (cucul_canvas_t *, unsigned int) |
Add a frame to a canvas. | |
int | cucul_free_canvas_frame (cucul_canvas_t *, unsigned int) |
Remove a frame from a canvas. |
|
This function returns the current canvas frame count. This function never fails.
|
|
This function sets the active canvas frame. All subsequent drawing operations will be performed on that frame. The current painting context set by cucul_set_color() or cucul_set_truecolor() is inherited. If the frame index is outside the canvas' frame range, nothing happens. If an error occurs, -1 is returned and errno is set accordingly:
|
|
This function creates a new frame within the given canvas. Its contents are copied from the currently active frame. The frame index indicates where the frame should be inserted. Valid values range from 0 to the current canvas frame count. If the frame index is greater the or equals the current canvas frame count, the new frame is appended at the end of the canvas. The active frame does not change, but its index may be renumbered due to the insertion. If an error occurs, -1 is returned and errno is set accordingly:
|
|
This function deletes a frame from a given canvas. It is not legal to remove the last frame from a canvas. Such a request will be ignored by cucul_free_canvas_frame(). The frame index indicates the frame to delete. Valid values range from 0 to the current canvas frame count minus 1. If the frame index is greater the or equals the current canvas frame count, the last frame is deleted. If the active frame is deleted, frame 0 becomes the new active frame. Otherwise, the active frame does not change, but its index may be renumbered due to the deletion. If an error occurs, -1 is returned and errno is set accordingly:
|