caca_frame - Online Linux Manual PageSection : 3caca
Updated : Tue Jan 26 2021
Source : Version 0.99.beta19
Note : libcaca
NAMEcaca_frame − libcaca canvas frame handling
SYNOPSIS
Moduleslibcaca bitmap dithering
Functions__extern int caca_get_frame_count (caca_canvas_t const *)
Get the number of frames in a canvas​. __extern int caca_set_frame (caca_canvas_t *, int)
Activate a given canvas frame​. __extern char const * caca_get_frame_name (caca_canvas_t const *)
Get the current frame's name​. __extern int caca_set_frame_name (caca_canvas_t *, char const *)
Set the current frame's name​. __extern int caca_create_frame (caca_canvas_t *, int)
Add a frame to a canvas​. __extern int caca_free_frame (caca_canvas_t *, int)
Remove a frame from a canvas​.
Detailed DescriptionThese functions provide high level routines for canvas frame insertion, removal, copying etc​.
Function Documentation
__extern int caca_get_frame_count (caca_canvas_t const * cv)Return the current canvas' frame count​. This function never fails​. Parameters cv A libcaca canvas Returns The frame count Referenced by caca_set_canvas_boundaries()​.
__extern int caca_set_frame (caca_canvas_t * cv, int id)Set the active canvas frame​. All subsequent drawing operations will be performed on that frame​. The current painting context set by caca_set_attr() 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: • EINVAL Requested frame is out of range​. Parameters cv A libcaca canvas
id The canvas frame to activate Returns 0 in case of success, -1 if an error occurred​. References caca_add_dirty_rect()​. Referenced by caca_set_canvas_boundaries()​.
__extern char const* caca_get_frame_name (caca_canvas_t const * cv)Return the current frame's name​. The returned string is valid until the frame is deleted or caca_set_frame_name() is called to change the frame name again​. This function never fails​. Parameters cv A libcaca canvas​. Returns The current frame's name​.
__extern int caca_set_frame_name (caca_canvas_t * cv, char const * name)Set the current frame's name​. Upon creation, a frame has a default name of 'frame#xxxxxxxx' where xxxxxxxx is a self-incrementing hexadecimal number​. If an error occurs, -1 is returned and errno is set accordingly: • ENOMEM Not enough memory to allocate new frame​. Parameters cv A libcaca canvas​.
name The name to give to the current frame​. Returns 0 in case of success, -1 if an error occurred​.
__extern int caca_create_frame (caca_canvas_t * cv, int id)Create a new frame within the given canvas​. Its contents and attributes 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 than or equals the current canvas frame count, the new frame is appended at the end of the canvas​. If the frame index is less than zero, the new frame is inserted at index 0​. 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: • ENOMEM Not enough memory to allocate new frame​. Parameters cv A libcaca canvas
id The index where to insert the new frame Returns 0 in case of success, -1 if an error occurred​. Referenced by caca_set_canvas_boundaries()​.
__extern int caca_free_frame (caca_canvas_t * cv, int id)Delete a frame from a given canvas​. 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 than 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: • EINVAL Requested frame is out of range, or attempt to delete the last frame of the canvas​. Parameters cv A libcaca canvas
id The index of the frame to delete Returns 0 in case of success, -1 if an error occurred​. References caca_add_dirty_rect()​.
AuthorGenerated automatically by Doxygen for libcaca from the source code​. 0
Johanes Gumabo
Data Size   :   22,224 byte
man-caca_get_frame_count.3cacaBuild   :   2024-12-05, 20:55   :  
Visitor Screen   :   x
Visitor Counter ( page / site )   :   2 / 201,342
Visitor ID   :     :  
Visitor IP   :   18.119.235.107   :  
Visitor Provider   :   AMAZON-02   :  
Provider Position ( lat x lon )   :   39.962500 x -83.006100   :   x
Provider Accuracy Radius ( km )   :   1000   :  
Provider City   :   Columbus   :  
Provider Province   :   Ohio ,   :   ,
Provider Country   :   United States   :  
Provider Continent   :   North America   :  
Visitor Recorder   :   Version   :  
Visitor Recorder   :   Library   :  
Online Linux Manual Page   :   Version   :   Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page   :   Library   :   lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page   :   Library   :   lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base   :   Version   :   Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base   :   Library   :   lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36
Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .
If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.