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

re-export everything from top-level for nicer docs

Browse source
This commit is contained in:
Vinzenz Schroeter 2024-09-07 12:23:32 +02:00
parent e97418b51b
commit eddeb2ea2d
12 changed files with 83 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

17
crates/servicepoint_binding_c/examples/lang_c/include/servicepoint.h
View file

@ -167,6 +167,8 @@ typedef struct SPPixelGrid SPPixelGrid;
/**
* Represents a span of memory (`&mut [u8]` ) as a struct usable by C code.
*
* You should not create an instance of this type in your C code.
*
* # Safety
*
* The caller has to make sure that:
@ -174,6 +176,8 @@ typedef struct SPPixelGrid SPPixelGrid;
* - accesses to the memory pointed to with `start` is never accessed outside `length`
* - the lifetime of the `CByteSlice` does not outlive the memory it points to, as described in
* the function returning this type.
* - an instance of this created from C is never passed to a consuming function, as the rust code
* will try to free the memory of a potentially separate allocator.
*/
typedef struct SPByteSlice {
/**
@ -186,11 +190,6 @@ typedef struct SPByteSlice {
size_t length;
} SPByteSlice;
/**
* Type alias for documenting the meaning of the variable in enum values
*/
typedef size_t SPOffset;
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
@ -556,7 +555,7 @@ size_t sp_brightness_grid_width(const struct SPBrightnessGrid *this_);
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct SPCommand *sp_command_bitmap_linear(SPOffset offset,
struct SPCommand *sp_command_bitmap_linear(size_t offset,
struct SPBitVec *bit_vec,
SPCompressionCode compression);
@ -581,7 +580,7 @@ struct SPCommand *sp_command_bitmap_linear(SPOffset offset,
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct SPCommand *sp_command_bitmap_linear_and(SPOffset offset,
struct SPCommand *sp_command_bitmap_linear_and(size_t offset,
struct SPBitVec *bit_vec,
SPCompressionCode compression);
@ -606,7 +605,7 @@ struct SPCommand *sp_command_bitmap_linear_and(SPOffset offset,
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct SPCommand *sp_command_bitmap_linear_or(SPOffset offset,
struct SPCommand *sp_command_bitmap_linear_or(size_t offset,
struct SPBitVec *bit_vec,
SPCompressionCode compression);
@ -652,7 +651,7 @@ struct SPCommand *sp_command_bitmap_linear_win(size_t x,
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct SPCommand *sp_command_bitmap_linear_xor(SPOffset offset,
struct SPCommand *sp_command_bitmap_linear_xor(size_t offset,
struct SPBitVec *bit_vec,
SPCompressionCode compression);