alex/rust_minifb
1
0
Fork 0
mirror of https://github.com/italicsjenga/rust_minifb.git synced 2024-12-23 11:21:30 +11:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs for update calles

Browse source
This commit is contained in:
Daniel Collin 2022-03-27 09:55:46 +02:00
parent abbe3db980
commit 48a41a9f6e
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/lib.rs
View file

@ -306,7 +306,8 @@ impl Window {
/// The upper 8-bits are ignored, the next 8-bits are for the red channel, the next 8-bits
/// afterwards for the green channel, and the lower 8-bits for the blue channel.
///
/// Notice that the buffer needs to be at least the size of the created window.
/// Notice that the buffer needs to be at least the size of the created window. Also only one of
/// `update_with_buffer` or `update` should be called for updating a single window.
///
/// # Examples
///
@ -365,6 +366,10 @@ impl Window {
/// pressing the close button on the window) It's up to the user to make sure that this is
/// being checked and take action depending on the state.
///
/// Notice that when using this function then `update_with_buffer` should not be called for the same window.
/// Only one of the functions should be used.
///
///
/// # Examples
///
/// ```no_run