Struct AllocatorMemoryRequirements

pub struct AllocatorMemoryRequirements {
    pub own_memory: bool,
    pub usage: MemoryUsage,
    pub required_flags: MemoryPropertyFlags,
    pub preferred_flags: Option<MemoryPropertyFlags>,
    pub never_allocate: bool,
}

In addition to normal MemoryRequirements, this struct provides additional details affecting how the allocator chooses memory to allocate.

Fields

own_memory: bool

Set to true if this allocation should have its own memory block.

Use it for special, big resources, like fullscreen images used as attachments.

This flag must also be used for host visible resources that you want to map simultaneously because otherwise they might end up as regions of the same DeviceMemory, and mapping the same DeviceMemory multiple times is illegal.

usage: MemoryUsage

Intended usage of the allocated memory. If you specify required_flags as non-empty, you can (but do not have to) leave this set to MemoryUsage::Unknown.

required_flags: MemoryPropertyFlags

Flags that must be satisfied by the memory type used for allocation. Can be left empty if usage is not MemoryUsage::Unknown.

preferred_flags: Option<MemoryPropertyFlags>

Flags that determine which memory types should be chosen preferentially over others. If this is not empty, it must be a superset of required_flags.

never_allocate: bool

Set this flag to only try to allocate from existing device memory blocks and never create new blocks.

If the new allocation cannot be placed in any of the existing blocks, allocation fails with Error::OutOfDeviceMemory.

It makes no sense to set own_memory and never_allocate at the same time.

Trait Implementations

impl Clone for AllocatorMemoryRequirements

fn clone(&self) -> AllocatorMemoryRequirements

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Hash for AllocatorMemoryRequirements

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AllocatorMemoryRequirements

fn cmp(&self, other: &AllocatorMemoryRequirements) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AllocatorMemoryRequirements

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AllocatorMemoryRequirements

fn partial_cmp(&self, other: &AllocatorMemoryRequirements) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for AllocatorMemoryRequirements

impl Eq for AllocatorMemoryRequirements

impl StructuralPartialEq for AllocatorMemoryRequirements