servicepoint/servicepoint-binding-c
0
2
Fork 0
Code Issues 1 Pull requests 1 Projects Releases 2 Packages Wiki Activity Actions

even more docs
All checks were successful
Rust / build-gnu-apt (pull_request) Successful in 4m16s
Details
Rust / build-size-gnu-unstable (pull_request) Successful in 1m18s
Details

Browse source
This commit is contained in:
Vinzenz Schroeter 2025-05-07 22:50:53 +02:00
parent 36f3d84dc8
commit b8a55d0433
7 changed files with 133 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

103
include/servicepoint.h
View file

@ -1131,6 +1131,9 @@ size_t sp_char_grid_width(CharGrid */*notnull*/ char_grid);
*/
BitmapCommand */*notnull*/ sp_cmd_bitmap_clone(BitmapCommand */*notnull*/ command);
/**
* Deallocates a [BitmapCommand] instance.
*/
void sp_cmd_bitmap_free(BitmapCommand */*notnull*/ command);
/**
@ -1151,14 +1154,18 @@ BitmapCommand */*notnull*/ sp_cmd_bitmap_from_bitmap(Bitmap */*notnull*/ bitmap)
*/
Bitmap */*notnull*/ sp_cmd_bitmap_get(BitmapCommand */*notnull*/ command);
/**
* Reads the compression kind of the [BitmapCommand].
*/
CompressionCode sp_cmd_bitmap_get_compression(BitmapCommand */*notnull*/ command);
/**
* Reads the origin field of the [BitmapCommand].
*/
void sp_cmd_bitmap_get_origin(BitmapCommand */*notnull*/ command,
size_t */*notnull*/ origin_x,
size_t */*notnull*/ origin_y);
Packet *sp_cmd_bitmap_into_packet(BitmapCommand */*notnull*/ command);
/**
* Sets a window of pixels to the specified values.
*
@ -1172,18 +1179,31 @@ BitmapCommand */*notnull*/ sp_cmd_bitmap_new(Bitmap */*notnull*/ bitmap,
CompressionCode compression);
/**
* Moves the provided bitmap to be contained in the command.
* Moves the provided [Bitmap] to be contained in the [BitmapCommand].
*/
void sp_cmd_bitmap_set(BitmapCommand */*notnull*/ command,
Bitmap */*notnull*/ bitmap);
/**
* Overwrites the compression kind of the [BitmapCommand].
*/
void sp_cmd_bitmap_set_compression(BitmapCommand */*notnull*/ command,
CompressionCode compression);
/**
* Overwrites the origin field of the [BitmapCommand].
*/
void sp_cmd_bitmap_set_origin(BitmapCommand */*notnull*/ command,
size_t origin_x,
size_t origin_y);
/**
* Tries to turn a [BitmapCommand] into a [Packet].
*
* Returns: NULL or a [Packet] containing the command.
*/
Packet *sp_cmd_bitmap_try_into_packet(BitmapCommand */*notnull*/ command);
/**
* Clones an [BitVecCommand] instance.
*
@ -1196,16 +1216,26 @@ BitVecCommand */*notnull*/ sp_cmd_bitvec_clone(BitVecCommand */*notnull*/ comman
*/
void sp_cmd_bitvec_free(BitVecCommand */*notnull*/ command);
/**
* Returns a pointer to the [BitVec] contained in the [BitVecCommand].
*/
BitVec *sp_cmd_bitvec_get(BitVecCommand */*notnull*/ command);
/**
* Reads the compression kind of the [BitVecCommand].
*/
CompressionCode sp_cmd_bitvec_get_compression(BitVecCommand */*notnull*/ command);
/**
* Reads the offset field of the [BitVecCommand].
*/
Offset sp_cmd_bitvec_get_offset(BitVecCommand */*notnull*/ command);
/**
* Returns the [BinaryOperation] of the command.
*/
BinaryOperation sp_cmd_bitvec_get_operation(BitVecCommand */*notnull*/ command);
Packet *sp_cmd_bitvec_into_packet(BitVecCommand */*notnull*/ command);
/**
* Set pixel data starting at the pixel offset on screen.
*
@ -1226,20 +1256,36 @@ BitVecCommand */*notnull*/ sp_cmd_bitvec_new(BitVec */*notnull*/ bitvec,
CompressionCode compression);
/**
* Moves the provided bitmap to be contained in the command.
* Moves the provided [BitVec] to be contained in the [BitVecCommand].
*/
void sp_cmd_bitvec_set(BitVecCommand */*notnull*/ command,
BitVec */*notnull*/ bitvec);
/**
* Overwrites the compression kind of the [BitVecCommand].
*/
void sp_cmd_bitvec_set_compression(BitVecCommand */*notnull*/ command,
CompressionCode compression);
/**
* Overwrites the offset field of the [BitVecCommand].
*/
void sp_cmd_bitvec_set_offset(BitVecCommand */*notnull*/ command,
Offset offset);
/**
* Overwrites the [BinaryOperation] of the command.
*/
void sp_cmd_bitvec_set_operation(BitVecCommand */*notnull*/ command,
BinaryOperation operation);
/**
* Tries to turn a [BitVecCommand] into a [Packet].
*
* Returns: NULL or a [Packet] containing the command.
*/
Packet *sp_cmd_bitvec_try_into_packet(BitVecCommand */*notnull*/ command);
/**
* Clones an [GlobalBrightnessCommand] instance.
*
@ -1284,12 +1330,23 @@ void sp_cmd_brightness_grid_free(BitmapCommand */*notnull*/ command);
*/
BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_from_grid(BrightnessGrid */*notnull*/ grid);
/**
* Returns a pointer to the [BrightnessGrid] contained in the [BrightnessGridCommand].
*/
BrightnessGrid *sp_cmd_brightness_grid_get(BrightnessGridCommand */*notnull*/ command);
/**
* Overwrites the origin field of the [BrightnessGridCommand].
*/
void sp_cmd_brightness_grid_get_origin(BrightnessGridCommand */*notnull*/ command,
size_t */*notnull*/ origin_x,
size_t */*notnull*/ origin_y);
/**
* Tries to turn a [BrightnessGridCommand] into a [Packet].
*
* Returns: NULL or a [Packet] containing the command.
*/
Packet *sp_cmd_brightness_grid_into_packet(BrightnessGridCommand */*notnull*/ command);
/**
@ -1304,11 +1361,14 @@ BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_new(BrightnessGrid */*
size_t origin_y);
/**
* Moves the provided bitmap to be contained in the command.
* Moves the provided [BrightnessGrid] to be contained in the [BrightnessGridCommand].
*/
void sp_cmd_brightness_grid_set(BrightnessGridCommand */*notnull*/ command,
BrightnessGrid */*notnull*/ grid);
/**
* Reads the origin field of the [BrightnessGridCommand].
*/
void sp_cmd_brightness_grid_set_origin(BrightnessGridCommand */*notnull*/ command,
size_t origin_x,
size_t origin_y);
@ -1331,14 +1391,18 @@ void sp_cmd_char_grid_free(BitmapCommand */*notnull*/ command);
*/
CharGridCommand */*notnull*/ sp_cmd_char_grid_from_grid(CharGrid */*notnull*/ grid);
/**
* Returns a pointer to the [CharGrid] contained in the [CharGridCommand].
*/
CharGrid *sp_cmd_char_grid_get(CharGridCommand */*notnull*/ command);
/**
* Reads the origin field of the [CharGridCommand].
*/
void sp_cmd_char_grid_get_origin(CharGridCommand */*notnull*/ command,
size_t */*notnull*/ origin_x,
size_t */*notnull*/ origin_y);
Packet *sp_cmd_char_grid_into_packet(CharGridCommand */*notnull*/ command);
/**
* Show UTF-8 encoded text on the screen.
*
@ -1351,15 +1415,25 @@ CharGridCommand */*notnull*/ sp_cmd_char_grid_new(CharGrid */*notnull*/ grid,
size_t origin_y);
/**
* Moves the provided bitmap to be contained in the command.
* Moves the provided [CharGrid] to be contained in the [CharGridCommand].
*/
void sp_cmd_char_grid_set(CharGridCommand */*notnull*/ command,
CharGrid */*notnull*/ grid);
/**
* Overwrites the origin field of the [CharGridCommand].
*/
void sp_cmd_char_grid_set_origin(CharGridCommand */*notnull*/ command,
size_t origin_x,
size_t origin_y);
/**
* Tries to turn a [CharGridCommand] into a [Packet].
*
* Returns: NULL or a [Packet] containing the command.
*/
Packet *sp_cmd_char_grid_try_into_packet(CharGridCommand */*notnull*/ command);
/**
* Deallocates a [ClearCommand].
*/
@ -1411,8 +1485,6 @@ void sp_cmd_cp437_grid_get_origin(Cp437GridCommand */*notnull*/ command,
size_t */*notnull*/ origin_x,
size_t */*notnull*/ origin_y);
Packet *sp_cmd_cp437_grid_into_packet(Cp437GridCommand */*notnull*/ command);
/**
* Show text on the screen.
*
@ -1441,6 +1513,13 @@ void sp_cmd_cp437_grid_set_origin(Cp437GridCommand */*notnull*/ command,
size_t origin_x,
size_t origin_y);
/**
* Tries to turn a [Cp437GridCommand] into a [Packet].
*
* Returns: NULL or a [Packet] containing the command.
*/
Packet *sp_cmd_cp437_grid_try_into_packet(Cp437GridCommand */*notnull*/ command);
/**
* Deallocates a [FadeOutCommand].
*/