Struct vulkano::memory::allocator::suballocator::Region

pub struct Region { /* private fields */ }

A region for a suballocator to allocate within. All suballocations will be in bounds of this region.

In order to prevent arithmetic overflow when allocating, the region’s end must not exceed DeviceLayout::MAX_SIZE.

The suballocator knowing the offset of the region rather than only the size allows you to easily suballocate suballocations. Otherwise, if regions were always relative, you would have to pick some maximum alignment for a suballocation before suballocating it further, to satisfy alignment requirements. However, you might not even know the maximum alignment requirement. Instead you can feed a suballocator a region that is aligned any which way, and it makes sure that the absolute offset of the suballocation has the requested alignment, meaning the offset that’s already offset by the region’s offset.

There’s one important caveat: if suballocating a suballocation, and the suballocation and the suballocation’s suballocations aren’t both only linear or only nonlinear, then the region must be aligned to the buffer-image granularity. Otherwise, there might be a buffer-image granularity conflict between the parent suballocator’s allocations and the child suballocator’s allocations.

Implementations

impl Region

pub const fn new(offset: DeviceSize, size: DeviceSize) -> Option<Self>

Creates a new Region from the given offset and size.

Returns None if the end of the region would exceed DeviceLayout::MAX_SIZE.

pub const unsafe fn new_unchecked(offset: DeviceSize, size: DeviceSize) -> Self

Creates a new Region from the given offset and size without doing any checks.

Safety

• The end of the region must not exceed DeviceLayout::MAX_SIZE, that is the infinite-precision sum of offset and size must not exceed the bound.

pub const fn offset(&self) -> DeviceSize

Returns the offset where the region begins.

pub const fn size(&self) -> DeviceSize

Returns the size of the region.

Trait Implementations

impl Clone for Region

fn clone(&self) -> Region

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Region

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

Formats the value using the given formatter.

impl Hash for Region

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 PartialEq for Region

fn eq(&self, other: &Region) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Region

impl Eq for Region

impl StructuralEq for Region

impl StructuralPartialEq for Region