Enum rokol::gfx::ResourceUsage

#[repr(u32)]
pub enum ResourceUsage {
    _Default,
    Immutable,
    Dynamic,
    Stream,
    _ForceU32,
    _Num,
}

Update strategy of buffers and images

Render target image has to have Immutable usage.

Kinds

• Immutable: Never be updated after creation
• Dynamic: Updated infrequently (“once after creation” to “quite often but not every frame”)
• Stream: Updated each frame

The rendering backends use this hint to prevent that the CPU needs to wait for the GPU when attempting to update a resource that might be currently accessed by the GPU.

Update frequency

Resource content is updated with the functions sg_update_buffer() or sg_append_buffer() for buffer objects, and sg_update_image() for image objects.

For the sg_update_*() functions, only one update is allowed per frame and resource object, while sg_append_buffer() can be called multiple times per frame on the same buffer. The application must update all data required for rendering (this means that the update data can be smaller than the resource size, if only a part of the overall resource size is used for rendering, you only need to make sure that the data that is used is valid).

Variants

_Default

Immutable

Dynamic

Stream

_ForceU32

_Num

Implementations

impl ResourceUsage

pub fn from_ffi(ffi_variant: sg_usage) -> Self

pub fn to_ffi(self) -> sg_usage

Trait Implementations

impl Clone for ResourceUsage

fn clone(&self) -> ResourceUsage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResourceUsage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<sg_usage> for ResourceUsage

fn from(ffi_variant: sg_usage) -> Self

Performs the conversion.

impl Hash for ResourceUsage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Into<sg_usage> for ResourceUsage

fn into(self) -> sg_usage

Performs the conversion.

impl PartialEq<ResourceUsage> for ResourceUsage

fn eq(&self, other: &ResourceUsage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for ResourceUsage

impl Eq for ResourceUsage

impl StructuralEq for ResourceUsage

impl StructuralPartialEq for ResourceUsage