Struct vulkano::buffer::sys::RawBuffer

pub struct RawBuffer { /* private fields */ }

A raw buffer, with no memory backing it.

This is the basic buffer type, a direct translation of a VkBuffer object, but it is mostly useless in this form. After creating a raw buffer, you must call bind_memory to make a complete buffer object.

Implementations

impl RawBuffer

pub fn new(
    device: Arc<Device>,
    create_info: BufferCreateInfo
) -> Result<Self, BufferError>

Creates a new RawBuffer.

Panics

• Panics if create_info.sharing is Concurrent with less than 2 items.
• Panics if create_info.size is zero.
• Panics if create_info.usage is empty.

pub unsafe fn from_handle(
    device: Arc<Device>,
    handle: Buffer,
    create_info: BufferCreateInfo
) -> Self

Creates a new RawBuffer from a raw object handle.

Safety

• handle must be a valid Vulkan object handle created from device.
• handle must refer to a buffer that has not yet had memory bound to it.
• create_info must match the info used to create the object.

pub fn bind_memory(
    self,
    allocation: MemoryAlloc
) -> Result<Buffer, (BufferError, RawBuffer, MemoryAlloc)>

Binds device memory to this buffer.

pub fn memory_requirements(&self) -> &MemoryRequirements

Returns the memory requirements for this buffer.

pub fn flags(&self) -> BufferCreateFlags

Returns the flags the buffer was created with.

pub fn size(&self) -> DeviceSize

Returns the size of the buffer in bytes.

pub fn usage(&self) -> &BufferUsage

Returns the usage the buffer was created with.

pub fn sharing(&self) -> &Sharing<SmallVec<[u32; 4]>>

Returns the sharing the buffer was created with.

pub fn external_memory_handle_types(&self) -> ExternalMemoryHandleTypes

Returns the external memory handle types that are supported with this buffer.

Trait Implementations

impl Debug for RawBuffer

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

Formats the value using the given formatter.

impl DeviceOwned for RawBuffer

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl Drop for RawBuffer

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for RawBuffer

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<RawBuffer> for RawBuffer

fn eq(&self, other: &Self) -> 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 VulkanObject for RawBuffer

type Handle = Buffer

The type of the object.

fn handle(&self) -> Self::Handle

Returns the raw Vulkan handle of the object.

impl Eq for RawBuffer