diff --git a/crates/servicepoint_binding_c/README.md b/crates/servicepoint_binding_c/README.md index fb2c70c..eacd65d 100644 --- a/crates/servicepoint_binding_c/README.md +++ b/crates/servicepoint_binding_c/README.md @@ -17,19 +17,19 @@ This crate contains C bindings for the `servicepoint` library, enabling users to #include "servicepoint.h" int main(void) { - sp2_Connection *connection = sp2_connection_open("localhost:2342"); + sp_Connection *connection = sp_connection_open("localhost:2342"); if (connection == NULL) return 1; - sp2_PixelGrid *pixels = sp2_pixel_grid_new(sp2_PIXEL_WIDTH, sp2_PIXEL_HEIGHT); - sp2_pixel_grid_fill(pixels, true); + sp_PixelGrid *pixels = sp_pixel_grid_new(sp_PIXEL_WIDTH, sp_PIXEL_HEIGHT); + sp_pixel_grid_fill(pixels, true); - sp2_Command *command = sp2_command_bitmap_linear_win(0, 0, pixels, Uncompressed); - sp2_Packet *packet = sp2_packet_from_command(command); - if (!sp2_connection_send(connection, packet)) + sp_Command *command = sp_command_bitmap_linear_win(0, 0, pixels, Uncompressed); + sp_Packet *packet = sp_packet_from_command(command); + if (!sp_connection_send(connection, packet)) return 1; - sp2_connection_dealloc(connection); + sp_connection_dealloc(connection); return 0; } ``` @@ -52,12 +52,12 @@ You have the choice of linking statically (recommended) or dynamically. ## Notes on differences to rust library -- function names are: `sp2_` \ \. -- Use the rust documentation. +- function names are: `sp_` \ \. - Instances get consumed in the same way they do when writing rust / C# code. Do not use an instance after an (implicit!) free. - Option or Result turn into nullable return values - check for NULL! - There are no specifics for C++ here yet. You might get a nicer header when generating directly for C++, but it should be usable. - Reading and writing to instances concurrently is not safe. Only reading concurrently is safe. +- documentation is included in the header and available [online](https://docs.rs/servicepoint_binding_c/latest/servicepoint_binding_c/) ## Everything else