8000 doc: RenderingBackend: grammar by 0Qwel · Pull Request #664 · not-fl3/miniquad · GitHub
[go: up one dir, main page]
Skip to content

doc: RenderingBackend: grammar #664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0Qwel wants to merge 1 commit into
base: master
Choose a base branch
from
Open

doc: RenderingBackend: grammar #664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 22 additions & 13 deletions src/graphics.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1283,41 +1283,50 @@ pub trait RenderingBackend {
fn buffer_update(&mut self, buffer: BufferId, data: BufferSource);

/// Size of buffer in bytes.
/// For 1 element, u16 buffer this will return 2.
///
/// for exemple: given a buffer containing one u16 item, this will return 2.
fn buffer_size(&mut self, buffer: BufferId) -> usize;

/// Delete GPU buffer, leaving handle unmodified.
///
/// More high-level code on top of miniquad probably is going to call this in Drop
/// implementation of some more RAII buffer object.
/// This provides no protection against using the deleted buffer.
///
/// Higher level code on top of miniquad will probably call this in a `Drop`
/// implementation.
///
/// There is no protection against using deleted buffers later. However its not an UB in OpenGl
/// and thats why this function is not marked as unsafe
/// Using a deleted buffer is not UB, so this function isn't marked as
/// unsafe.
fn delete_buffer(&mut self, buffer: BufferId);

/// Delete GPU texture, leaving handle unmodified.
///
/// More high-level code on top of miniquad probably is going to call this in Drop
/// implementation of some more RAII buffer object.
/// This provides no protection against using the deleted texture.
///
/// There is no protection against using deleted textures later. However its not a CPU-level UB
/// and thats why this function is not marked as unsafe
/// Higher level code on top of miniquad will probably call this in a `Drop`
/// implementation.
///
/// Using a deleted texture is not a CPU-level UB, so this function isn't
/// marked as unsafe.
fn delete_texture(&mut self, texture: TextureId);

/// Delete GPU program, leaving handle unmodified.
///
/// More high-level code on top of miniquad probably is going to call this in Drop
/// implementation of some more RAII buffer object.
/// This provides no protection against using the deleted program.
///
/// Higher level code on top of miniquad will probably call this in a `Drop`
/// implementation.
///
/// There is no protection against using deleted programs later. However its not a CPU-level
/// Porgram and thats why this function is not marked as unsafe
/// Using a deleted program is not a CPU-level UB, so this function isn't
/// marked as unsafe.
fn delete_shader(&mut self, program: ShaderId);

/// Set a new viewport rectangle.
///
/// Should be applied after begin_pass.
fn apply_viewport(&mut self, x: i32, y: i32, w: i32, h: i32);

/// Set a new scissor rectangle.
///
/// Should be applied after begin_pass.
fn apply_scissor_rect(&mut self, x: i32, y: i32, w: i32, h: i32);

Expand Down
Loading
0