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

improve which doc line is the first because this one is displayed in docs in the overview

Browse source
This commit is contained in:
Vinzenz Schroeter 2024-09-07 14:44:25 +02:00
parent acc35b6727
commit c712b037d0
6 changed files with 140 additions and 101 deletions
Download patch file Download diff file Expand all files Collapse all files

77
crates/servicepoint_binding_c/src/command.rs
View file

@ -20,8 +20,8 @@ use crate::{
/// # Examples
///
/// ```C
/// sp_connection_send(connection, sp_command_clear());
/// sp_connection_send(connection, sp_command_brightness(5));
/// sp_connection_send_command(connection, sp_command_clear());
/// sp_connection_send_command(connection, sp_command_brightness(5));
/// ```
pub struct SPCommand(pub(crate) servicepoint::Command);
@ -31,7 +31,9 @@ impl Clone for SPCommand {
}
}
/// Tries to turn a `SPPacket` into a `SPCommand`. The packet is deallocated in the process.
/// Tries to turn a `SPPacket` into a `SPCommand`.
///
/// The packet is deallocated in the process.
///
/// Returns: pointer to new `SPCommand` instance or NULL
///
@ -72,14 +74,16 @@ pub unsafe extern "C" fn sp_command_clone(
Box::into_raw(Box::new((*original).clone()))
}
/// Allocates a new `Command::Clear` instance.
/// Set all pixels to the off state.
///
/// Set all pixels to the off state. Does not affect brightness.
/// Does not affect brightness.
///
/// Returns: a new `Command::Clear` instance. Will never return NULL.
///
/// # Examples
///
/// ```C
/// sp_connection_send(connection, sp_command_clear());
/// sp_connection_send_command(connection, sp_command_clear());
/// ```
///
/// # Safety
@ -93,11 +97,12 @@ pub unsafe extern "C" fn sp_command_clear() -> *mut SPCommand {
Box::into_raw(Box::new(SPCommand(servicepoint::Command::Clear)))
}
/// Allocates a new `Command::HardReset` instance.
///
/// Kills the udp daemon on the display, which usually results in a restart.
///
/// Please do not send this in your normal program flow.
///
/// Returns: a new `Command::HardReset` instance. Will never return NULL.
///
/// # Safety
///
/// The caller has to make sure that:
@ -109,7 +114,9 @@ pub unsafe extern "C" fn sp_command_hard_reset() -> *mut SPCommand {
Box::into_raw(Box::new(SPCommand(servicepoint::Command::HardReset)))
}
/// Allocates a new `Command::FadeOut` instance.
/// A yet-to-be-tested command.
///
/// Returns: a new `Command::FadeOut` instance. Will never return NULL.
///
/// # Safety
///
@ -122,8 +129,9 @@ pub unsafe extern "C" fn sp_command_fade_out() -> *mut SPCommand {
Box::into_raw(Box::new(SPCommand(servicepoint::Command::FadeOut)))
}
/// Allocates a new `Command::Brightness` instance for setting the brightness of all tiles to the
/// same value.
/// Set the brightness of all tiles to the same value.
///
/// Returns: a new `Command::Brightness` instance. Will never return NULL.
///
/// # Panics
///
@ -146,10 +154,11 @@ pub unsafe extern "C" fn sp_command_brightness(
))))
}
/// Allocates a new `Command::CharBrightness` instance.
/// Set the brightness of individual tiles in a rectangular area of the display.
///
/// The passed `SPBrightnessGrid` gets consumed.
///
/// Set the brightness of individual tiles in a rectangular area of the display.
/// Returns: a new `Command::CharBrightness` instance. Will never return NULL.
///
/// # Safety
///
@ -172,9 +181,6 @@ pub unsafe extern "C" fn sp_command_char_brightness(
))))
}
/// Allocates a new `Command::BitmapLinear` instance.
/// The passed `SPBitVec` gets consumed.
///
/// Set pixel data starting at the pixel offset on screen.
///
/// The screen will continuously overwrite more pixel data without regarding the offset, meaning
@ -182,6 +188,10 @@ pub unsafe extern "C" fn sp_command_char_brightness(
///
/// The contained `SPBitVec` is always uncompressed.
///
/// The passed `SPBitVec` gets consumed.
///
/// Returns: a new `Command::BitmapLinear` instance. Will never return NULL.
///
/// # Safety
///
/// The caller has to make sure that:
@ -205,9 +215,6 @@ pub unsafe extern "C" fn sp_command_bitmap_linear(
))))
}
/// Allocates a new `Command::BitmapLinearAnd` instance.
/// The passed `SPBitVec` gets consumed.
///
/// Set pixel data according to an and-mask starting at the offset.
///
/// The screen will continuously overwrite more pixel data without regarding the offset, meaning
@ -215,6 +222,10 @@ pub unsafe extern "C" fn sp_command_bitmap_linear(
///
/// The contained `SPBitVec` is always uncompressed.
///
/// The passed `SPBitVec` gets consumed.
///
/// Returns: a new `Command::BitmapLinearAnd` instance. Will never return NULL.
///
/// # Safety
///
/// The caller has to make sure that:
@ -238,9 +249,6 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_and(
))))
}
/// Allocates a new `Command::BitmapLinearOr` instance.
/// The passed `SPBitVec` gets consumed.
///
/// Set pixel data according to an or-mask starting at the offset.
///
/// The screen will continuously overwrite more pixel data without regarding the offset, meaning
@ -248,6 +256,10 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_and(
///
/// The contained `SPBitVec` is always uncompressed.
///
/// The passed `SPBitVec` gets consumed.
///
/// Returns: a new `Command::BitmapLinearOr` instance. Will never return NULL.
///
/// # Safety
///
/// The caller has to make sure that:
@ -271,9 +283,6 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_or(
))))
}
/// Allocates a new `Command::BitmapLinearXor` instance.
/// The passed `SPBitVec` gets consumed.
///
/// Set pixel data according to a xor-mask starting at the offset.
///
/// The screen will continuously overwrite more pixel data without regarding the offset, meaning
@ -281,6 +290,10 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_or(
///
/// The contained `SPBitVec` is always uncompressed.
///
/// The passed `SPBitVec` gets consumed.
///
/// Returns: a new `Command::BitmapLinearXor` instance. Will never return NULL.
///
/// # Safety
///
/// The caller has to make sure that:
@ -304,9 +317,6 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_xor(
))))
}
/// Allocates a new `Command::Cp437Data` instance.
/// The passed `SPCp437Grid` gets consumed.
///
/// Show text on the screen.
///
/// <div class="warning">
@ -314,7 +324,9 @@ pub unsafe extern "C" fn sp_command_bitmap_linear_xor(
/// Because Rust expects UTF-8 strings, it might be necessary to only send ASCII for now.
/// </div>
///
/// Will never return NULL.
/// The passed `SPCp437Grid` gets consumed.///
///
/// Returns: a new `Command::Cp437Data` instance. Will never return NULL.
///
/// # Safety
///
@ -337,12 +349,11 @@ pub unsafe extern "C" fn sp_command_cp437_data(
))))
}
/// Allocates a new `Command::BitmapLinearWin` instance.
/// The passed `SPPixelGrid` gets consumed.
///
/// Sets a window of pixels to the specified values.
///
/// Will never return NULL.
/// The passed `SPPixelGrid` gets consumed.
///
/// Returns: a new `Command::BitmapLinearWin` instance. Will never return NULL.
///
/// # Safety
///

4
crates/servicepoint_binding_c/src/connection.rs
View file

@ -14,7 +14,7 @@ use crate::{SPCommand, SPPacket};
/// ```C
/// CConnection connection = sp_connection_open("172.23.42.29:2342");
/// if (connection != NULL)
/// sp_connection_send(connection, sp_command_clear());
/// sp_connection_send_command(connection, sp_command_clear());
/// ```
pub struct SPConnection(pub(crate) servicepoint::Connection);
@ -46,6 +46,7 @@ pub unsafe extern "C" fn sp_connection_open(
}
/// Sends a `SPPacket` to the display using the `SPConnection`.
///
/// The passed `SPPacket` gets consumed.
///
/// returns: true in case of success
@ -67,6 +68,7 @@ pub unsafe extern "C" fn sp_connection_send_packet(
}
/// Sends a `SPCommand` to the display using the `SPConnection`.
///
/// The passed `SPCommand` gets consumed.
///
/// returns: true in case of success

2
crates/servicepoint_binding_c/src/lib.rs
View file

@ -17,7 +17,7 @@
//! sp_pixel_grid_fill(pixels, true);
//!
//! SPCommand *command = sp_command_bitmap_linear_win(0, 0, pixels, Uncompressed);
//! while (sp_connection_send(connection, sp_command_clone(command)));
//! while (sp_connection_send_command(connection, sp_command_clone(command)));
//!
//! sp_packet_free(packet);
//! sp_connection_free(connection);