#include <stick2xyz.h>
Go to the source code of this file.
Macros | |
| #define | PANE2DRGB_H (1) |
Macro Definition Documentation
◆ PANE2DRGB_H
| #define PANE2DRGB_H (1) |
Definition at line 21 of file pane2drgb.h.
Function Documentation
◆ pane2drgb_addref()
| int pane2drgb_addref | ( | pane2d_handle | pane | ) |
See mod_pane2d_addref for more information.
◆ pane2drgb_alloc()
| pane2d_handle pane2drgb_alloc | ( | int | x, |
| int | y | ||
| ) |
See mod_pane2d_alloc for more information.
◆ pane2drgb_alloc_multithread()
| pane2d_handle pane2drgb_alloc_multithread | ( | int | x, |
| int | y, | ||
| size_t | maxthreads, | ||
| uint32_t | typesallowed | ||
| ) |
See mod_pane2d_alloc_multithread for more information.
◆ pane2drgb_can_multithread()
| int pane2drgb_can_multithread | ( | void | ) |
See mod_pane2d_can_multithread for more information.
◆ pane2drgb_candraw()
| int pane2drgb_candraw | ( | pane2d_handle | pane | ) |
See mod_pane2d_candraw for more information.
◆ pane2drgb_changeaccesscontrol()
| int pane2drgb_changeaccesscontrol | ( | pane2d_handle | pane, |
| thrd_t * | hthread, | ||
| int | hthreadsize, | ||
| uint32_t | flags | ||
| ) |
See mod_pane2d_changeaccesscontrol for more information.
◆ pane2drgb_changeowningthread()
| int pane2drgb_changeowningthread | ( | pane2d_handle | pane, |
| void * | newthread, | ||
| int | addref | ||
| ) |
See mod_pane2d_changeowningthread for more information.
◆ pane2drgb_clear()
| void pane2drgb_clear | ( | pane2d_handle | pane | ) |
See mod_pane2d_clear for more information.
◆ pane2drgb_colortype()
| uint32_t pane2drgb_colortype | ( | void | ) |
See mod_pane2d_colortype for more information.
- Note
- This function always returns STICK2XYZ_PANE2D_COLORTYPE_RGB
◆ pane2drgb_desc()
| stick2xyz_pctchar pane2drgb_desc | ( | void | ) |
Returns the the internally stored module short description.
See mod_pane2d_desc for more information.
- Return values
-
stick2xyz_pctchar The constant module short description.
◆ pane2drgb_drawcircle()
| void pane2drgb_drawcircle | ( | pane2d_handle | pane, |
| int | d, | ||
| int | x, | ||
| int | y, | ||
| int | r | ||
| ) |
See mod_pane2d_drawcircle for more information.
◆ pane2drgb_drawellipse()
| void pane2drgb_drawellipse | ( | pane2d_handle | pane, |
| int | d, | ||
| int | x, | ||
| int | y, | ||
| int | rx, | ||
| int | ry | ||
| ) |
See mod_pane2d_drawellipse for more information.
◆ pane2drgb_drawline()
| void pane2drgb_drawline | ( | pane2d_handle | pane, |
| int | d, | ||
| int | x1, | ||
| int | y1, | ||
| int | x2, | ||
| int | y2 | ||
| ) |
See mod_pane2d_drawline for more information.
◆ pane2drgb_drawpixel()
| void pane2drgb_drawpixel | ( | pane2d_handle | pane, |
| int | x, | ||
| int | y | ||
| ) |
See mod_pane2d_drawpixel for more information.
◆ pane2drgb_drawrect()
| void pane2drgb_drawrect | ( | pane2d_handle | pane, |
| int | d, | ||
| int | x1, | ||
| int | y1, | ||
| int | x2, | ||
| int | y2 | ||
| ) |
See mod_pane2d_drawrect for more information.
◆ pane2drgb_drawrighttriangle()
| void pane2drgb_drawrighttriangle | ( | pane2d_handle | pane, |
| int | d, | ||
| int | x1, | ||
| int | y1, | ||
| int | x2, | ||
| int | y2, | ||
| int | b | ||
| ) |
See mod_pane2d_drawrighttriangle for more information.
◆ pane2drgb_drawsquare()
| void pane2drgb_drawsquare | ( | pane2d_handle | pane, |
| int | d, | ||
| int | l, | ||
| int | x1, | ||
| int | y1 | ||
| ) |
See mod_pane2d_drawsquare for more information.
◆ pane2drgb_drawtriangle()
| void pane2drgb_drawtriangle | ( | pane2d_handle | pane, |
| int | d, | ||
| int | x1, | ||
| int | y1, | ||
| int | x2, | ||
| int | y2, | ||
| int | x3, | ||
| int | y3 | ||
| ) |
See mod_pane2d_drawtriangle for more information.
◆ pane2drgb_drawtworighttriangles()
| void pane2drgb_drawtworighttriangles | ( | pane2d_handle | pane, |
| int | d, | ||
| int | x1, | ||
| int | y1, | ||
| int | x2, | ||
| int | y2 | ||
| ) |
This function is not implemented, so it just returns to caller. See mod_pane2d_drawtworighttriangles for more information.
◆ pane2drgb_dupdata()
| uint8_t ** pane2drgb_dupdata | ( | pane2d_handle | pane, |
| int | padding | ||
| ) |
See mod_pane2d_dupdata for more information.
- Note
- Function always returns NULL.
◆ pane2drgb_dupdata16p()
| uint16_t * pane2drgb_dupdata16p | ( | pane2d_handle | pane, |
| int | padding | ||
| ) |
See mod_pane2d_dupdata16p for more information.
◆ pane2drgb_dupdatap()
| uint8_t * pane2drgb_dupdatap | ( | pane2d_handle | pane, |
| int | padding | ||
| ) |
See mod_pane2d_dupdatap for more information.
◆ pane2drgb_dupfunc_getlist()
| int pane2drgb_dupfunc_getlist | ( | uint32_t | typerequested, |
| struct pane2d_dupgen_funcs * | dest | ||
| ) |
See mod_pane2d_dupfunc_getlist for more information.
◆ pane2drgb_dupimage()
| uint8_t ** pane2drgb_dupimage | ( | pane2d_handle | pane, |
| int | padding | ||
| ) |
See mod_pane2d_dupimage for more information.
◆ pane2drgb_dupimage16()
| uint16_t ** pane2drgb_dupimage16 | ( | pane2d_handle | pane, |
| int | padding | ||
| ) |
See mod_pane2d_dupimage16 for more information.
◆ pane2drgb_dupxy()
| void pane2drgb_dupxy | ( | pane2d_handle | pane, |
| int * | x, | ||
| int * | y | ||
| ) |
See mod_pane2d_dupxy for more information.
◆ pane2drgb_eventreleased()
| void * pane2drgb_eventreleased | ( | pane2d_handle | pane | ) |
See mod_pane2d_eventreleased for more information.
◆ pane2drgb_fillcircle()
| void pane2drgb_fillcircle | ( | pane2d_handle | pane, |
| pane2d_texture_handle | src, | ||
| int | x, | ||
| int | y, | ||
| int | r | ||
| ) |
See mod_pane2d_fillcircle for more information.
◆ pane2drgb_fillellipse()
| void pane2drgb_fillellipse | ( | pane2d_handle | pane, |
| pane2d_texture_handle | src, | ||
| int | x, | ||
| int | y, | ||
| int | rx, | ||
| int | ry | ||
| ) |
See mod_pane2d_fillellipse for more information.
◆ pane2drgb_fillrect()
| void pane2drgb_fillrect | ( | pane2d_handle | pane, |
| pane2d_texture_handle | src, | ||
| int | x1, | ||
| int | y1, | ||
| int | x2, | ||
| int | y2 | ||
| ) |
See mod_pane2d_fillrect for more information.
◆ pane2drgb_fillrighttriangle()
| void pane2drgb_fillrighttriangle | ( | pane2d_handle | pane, |
| pane2d_texture_handle | src, | ||
| int | x1, | ||
| int | y1, | ||
| int | x2, | ||
| int | y2, | ||
| int | b | ||
| ) |
See mod_pane2d_fillrighttriangle for more information.
◆ pane2drgb_fillsquare()
| void pane2drgb_fillsquare | ( | pane2d_handle | pane, |
| pane2d_texture_handle | src, | ||
| int | l, | ||
| int | x1, | ||
| int | y1 | ||
| ) |
See mod_pane2d_fillsquare for more information.
◆ pane2drgb_filltriangle()
| void pane2drgb_filltriangle | ( | pane2d_handle | pane, |
| pane2d_texture_handle | src, | ||
| int | x1, | ||
| int | y1, | ||
| int | x2, | ||
| int | y2, | ||
| int | x3, | ||
| int | y3 | ||
| ) |
See mod_pane2d_filltriangle for more information.
◆ pane2drgb_free()
| void pane2drgb_free | ( | pane2d_handle | pane | ) |
See mod_pane2d_free for more information.
◆ pane2drgb_freedata16p()
| void pane2drgb_freedata16p | ( | pane2d_handle | pane, |
| uint16_t * | image | ||
| ) |
See mod_pane2d_freedata16p for more information.
◆ pane2drgb_freedatap()
| void pane2drgb_freedatap | ( | pane2d_handle | pane, |
| uint8_t * | image | ||
| ) |
See mod_pane2d_freedatap for more information.
◆ pane2drgb_freedrawaclinfo_windows()
| BOOL pane2drgb_freedrawaclinfo_windows | ( | pane2d_handle | pane, |
| struct pane2d_drawacl * | src | ||
| ) |
See mod_pane2d_freedrawaclinfo_windows for more information.
◆ pane2drgb_freeimage()
| void pane2drgb_freeimage | ( | pane2d_handle | pane, |
| uint8_t ** | image | ||
| ) |
See mod_pane2d_freeimage for more information.
◆ pane2drgb_freeimage16()
| void pane2drgb_freeimage16 | ( | pane2d_handle | pane, |
| uint16_t ** | image | ||
| ) |
See mod_pane2d_freeimage16 for more information.
◆ pane2drgb_get_bpp()
| int pane2drgb_get_bpp | ( | void | ) |
This function always returns 8.
See mod_pane2d_get_bpp for more information.
◆ pane2drgb_getdrawaclinfo_windows()
| BOOL pane2drgb_getdrawaclinfo_windows | ( | pane2d_handle | pane, |
| struct pane2d_drawacl * | dest | ||
| ) |
See mod_pane2d_getdrawaclinfo_windows for more information.
◆ pane2drgb_getownerinfo_windows()
| DWORD pane2drgb_getownerinfo_windows | ( | pane2d_handle | pane, |
| LPHANDLE | destvar | ||
| ) |
See mod_pane2d_getownerinfo_windows for more information.
◆ pane2drgb_getref()
| void pane2drgb_getref | ( | pane2d_handle | pane, |
| int * | refcount, | ||
| int * | refwaiting | ||
| ) |
See mod_pane2d_getref for more information.
◆ pane2drgb_is_multithreaded()
| int pane2drgb_is_multithreaded | ( | pane2d_handle | pane | ) |
See mod_pane2d_is_multithreaded for more information.
◆ pane2drgb_isowner()
| int pane2drgb_isowner | ( | pane2d_handle | pane | ) |
See mod_pane2d_isowner for more information.
◆ pane2drgb_lang()
| void pane2drgb_lang | ( | stick2xyz_print_ptr | newval | ) |
Changes the pointer type of the language pack calling function.
- Warning
- This function is only used by the stick2xyz program's dynamic module loader. This function should not be called when the library is linked during the program build process.
- Note
- This function is not implemented on Windows builds.
See mod_pane2d_lang for more information.
- Parameters
-
[in] newval The new function pointer to store.
◆ pane2drgb_name()
| stick2xyz_pctchar pane2drgb_name | ( | void | ) |
Returns the internally stored UNIX module name.
See mod_pane2d_name for more information.
- Return values
-
stick2xyz_pctchar String "pane2drgb"
◆ pane2drgb_print_segment()
| void pane2drgb_print_segment | ( | pane2d_handle | image, |
| int | use_rgb | ||
| ) |
This function prints a small amount of information stored in a pane2d_handle to ttyoutput.
- Note
- This function is only available in debug builds. Define DEBUG before including stick2xyz.h to use this function. You can use –modlist to check for the word DEBUG in the module type. If the word DEBUG exists, this function is supported.
See mod_pane2d_print_segment for more information.
- Parameters
-
[in] image The handle to operate on. [in] use_rgb 1 to output in three bytes, 0 for one byte.
◆ pane2drgb_releaseref()
| int pane2drgb_releaseref | ( | pane2d_handle | pane, |
| int | asyncrelease, | ||
| int | shutdown | ||
| ) |
See mod_pane2d_releaseref for more information.
◆ pane2drgb_set_tty()
| void pane2drgb_set_tty | ( | void * | fildescout, |
| void * | fildescerr | ||
| ) |
This function sets the file descriptors for writing to the terminal.
By default, the library uses stdout and stderr.
See mod_pane2d_set_tty for more information.
- Parameters
-
[in] fildescout The file descriptor for stdout, a FILE *. [in] fildescerr The file descriptor for stderr, a FILE *.
◆ pane2drgb_termwaituntilowner()
| int pane2drgb_termwaituntilowner | ( | pane2d_handle | pane | ) |
See mod_pane2d_termwaituntilowner for more information.
◆ pane2drgb_texture_add_gray()
| uint64_t pane2drgb_texture_add_gray | ( | pane2d_handle | pane, |
| uint8_t | gray, | ||
| uint8_t | alpha, | ||
| pane2d_texture_handle * | dest | ||
| ) |
See mod_pane2d_texture_add_gray for more information.
◆ pane2drgb_texture_add_gray16()
| uint64_t pane2drgb_texture_add_gray16 | ( | pane2d_handle | pane, |
| uint16_t | gray, | ||
| uint16_t | alpha, | ||
| pane2d_texture_handle * | dest | ||
| ) |
The values of gray and alpha are converted to 8-bit values since the module stores image data in 24 bpp.
See mod_pane2d_texture_add_gray16 for more information.
◆ pane2drgb_texture_add_rgb()
| uint64_t pane2drgb_texture_add_rgb | ( | pane2d_handle | pane, |
| uint8_t | red, | ||
| uint8_t | green, | ||
| uint8_t | blue, | ||
| uint8_t | alpha, | ||
| pane2d_texture_handle * | dest | ||
| ) |
See mod_pane2d_texture_add_rgb for more information.
◆ pane2drgb_texture_add_rgb16()
| uint64_t pane2drgb_texture_add_rgb16 | ( | pane2d_handle | pane, |
| uint16_t | red, | ||
| uint16_t | green, | ||
| uint16_t | blue, | ||
| uint16_t | alpha, | ||
| pane2d_texture_handle * | dest | ||
| ) |
The values of RGB and alpha are converted to 8-bit values since the module stores image data in 24 bpp.
See mod_pane2d_texture_add_rgb16 for more information.
◆ pane2drgb_texture_clear()
| void pane2drgb_texture_clear | ( | pane2d_handle | pane | ) |
See mod_pane2d_texture_clear for more information.
◆ pane2drgb_texture_enum()
| int pane2drgb_texture_enum | ( | pane2d_handle | pane, |
| pane2d_texture_handle * | dest, | ||
| uint64_t | number | ||
| ) |
See mod_pane2d_texture_enum for more information.
◆ pane2drgb_type()
| int pane2drgb_type | ( | void | ) |
Returns the integer describing the module type.
The possible values are:
ASCII Modules:
STICK2XYZ_MODTYPE_PANE2D_DEBUG
UNICODE Modules:
STICK2XYZ_MODTYPE_PANE2D_UNICODE
STICK2XYZ_MODTYPE_PANE2D_UNICODE_DEBUG
See mod_pane2d_type for more information.
- Return values
-
int The module type as described above.
◆ pane2drgb_version()
| void pane2drgb_version | ( | int * | dest | ) |
Sets up the major, minor, and revision numbers into three integers.
See mod_pane2d_version for more information.
- Parameters
-
[out] dest An array of three integers to receive the module data.
◆ pane2drgb_vertex_get()
| int pane2drgb_vertex_get | ( | pane2d_handle | pane, |
| int | elm, | ||
| struct pane2d_vertex_elm * | dest | ||
| ) |
See mod_pane2d_vertex_get for more information.
◆ pane2drgb_vertex_get_v2()
| int pane2drgb_vertex_get_v2 | ( | pane2d_handle | pane, |
| int | elm, | ||
| struct pane2d_vertex_elm_v2 * | dest | ||
| ) |
See mod_pane2d_vertex_get_v2 for more information.
◆ pane2drgb_vertex_getopts()
| uint32_t pane2drgb_vertex_getopts | ( | pane2d_handle | pane | ) |
See mod_pane2d_vertex_getopts for more information.
◆ pane2drgb_vertex_setopts()
| void pane2drgb_vertex_setopts | ( | pane2d_handle | pane, |
| uint32_t | newopts | ||
| ) |
See mod_pane2d_vertex_setopts for more information.
◆ pane2drgb_waituntilowner()
| int pane2drgb_waituntilowner | ( | pane2d_handle | pane, |
| int | addref | ||
| ) |
See mod_pane2d_waituntilowner for more information.