Struct external_memory::ExternalMemoryTypeFlags

pub struct ExternalMemoryTypeFlags { /* fields omitted */ }

External memory type flags.

Implementations

impl ExternalMemoryTypeFlags

pub const OPAQUE_FD: ExternalMemoryTypeFlags

This is supported on Unix only. Specifies a POSIX file descriptor handle that has only limited valid usage outside of Vulkan and other compatible APIs. It must be compatible with the POSIX system calls dup, dup2, close, and the non-standard system call dup3. Additionally, it must be transportable over a socket using an SCM_RIGHTS control message. It owns a reference to the underlying memory resource represented by its memory object.

pub const OPAQUE_WIN32: ExternalMemoryTypeFlags

This is supported on Windows only. Specifies an NT handle that has only limited valid usage outside of Vulkan and other compatible APIs. It must be compatible with the functions DuplicateHandle, CloseHandle, CompareObjectHandles, GetHandleInformation, and SetHandleInformation. It owns a reference to the underlying memory resource represented by its memory object.

pub const OPAQUE_WIN32_KMT: ExternalMemoryTypeFlags

This is supported on Windows only. Specifies a global share handle that has only limited valid usage outside of Vulkan and other compatible APIs. It is not compatible with any native APIs. It does not own a reference to the underlying memory resource represented by its memory object, and will therefore become invalid when all the memory objects with it are destroyed.

pub const D3D11_TEXTURE: ExternalMemoryTypeFlags

This is supported on Windows only. Specifies an NT handle returned by IDXGIResource1::CreateSharedHandle referring to a Direct3D 10 or 11 texture resource. It owns a reference to the memory used by the Direct3D resource.

pub const D3D11_TEXTURE_KMT: ExternalMemoryTypeFlags

This is supported on Windows only. Specifies a global share handle returned by IDXGIResource::GetSharedHandle referring to a Direct3D 10 or 11 texture resource. It does not own a reference to the underlying Direct3D resource, and will therefore become invalid when all the memory objects and Direct3D resources associated with it are destroyed.

pub const D3D12_HEAP: ExternalMemoryTypeFlags

This is supported on Windows only. Specifies an NT handle returned by ID3D12Device::CreateSharedHandle referring to a Direct3D 12 heap resource. It owns a reference to the resources used by the Direct3D heap.

pub const D3D12_RESOURCE: ExternalMemoryTypeFlags

This is supported on Windows only. Specifies an NT handle returned by ID3D12Device::CreateSharedHandle referring to a Direct3D 12 committed resource. It owns a reference to the memory used by the Direct3D resource.

pub const DMA_BUF: ExternalMemoryTypeFlags

This is supported on Linux or Android only. Is a file descriptor for a Linux dma_buf. It owns a reference to the underlying memory resource represented by its memory object.

pub const ANDROID_HARDWARE_BUFFER: ExternalMemoryTypeFlags

This is supported on Android only. Specifies an AHardwareBuffer object defined by the Android NDK. See Android Hardware Buffers for more details of this handle type.

pub const HOST_ALLOCATION: ExternalMemoryTypeFlags

Specifies a host pointer returned by a host memory allocation command. It does not own a reference to the underlying memory resource, and will therefore become invalid if the host memory is freed.

pub const HOST_MAPPED_FOREIGN_MEMORY: ExternalMemoryTypeFlags

Specifies a host pointer to host mapped foreign memory. It does not own a reference to the underlying memory resource, and will therefore become invalid if the foreign memory is unmapped or otherwise becomes no longer available.

pub const fn empty() -> ExternalMemoryTypeFlags

Returns an empty set of flags

pub const fn all() -> ExternalMemoryTypeFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<ExternalMemoryTypeFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> ExternalMemoryTypeFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> ExternalMemoryTypeFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: ExternalMemoryTypeFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: ExternalMemoryTypeFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: ExternalMemoryTypeFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: ExternalMemoryTypeFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: ExternalMemoryTypeFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: ExternalMemoryTypeFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for ExternalMemoryTypeFlags

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

Formats the value using the given formatter.

impl BitAnd<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

fn bitand(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags

Returns the intersection between the two sets of flags.

type Output = ExternalMemoryTypeFlags

The resulting type after applying the & operator.

impl BitAndAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

fn bitand_assign(&mut self, other: ExternalMemoryTypeFlags)

Disables all flags disabled in the set.

impl BitOr<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

fn bitor(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags

Returns the union of the two sets of flags.

type Output = ExternalMemoryTypeFlags

The resulting type after applying the | operator.

impl BitOrAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

fn bitor_assign(&mut self, other: ExternalMemoryTypeFlags)

Adds the set of flags.

impl BitXor<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

fn bitxor(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags

Returns the left flags, but with all the right flags toggled.

type Output = ExternalMemoryTypeFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

fn bitxor_assign(&mut self, other: ExternalMemoryTypeFlags)

Toggles the set of flags.

impl Clone for ExternalMemoryTypeFlags

fn clone(&self) -> ExternalMemoryTypeFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalMemoryTypeFlags

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

Formats the value using the given formatter.

impl Extend<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

fn extend<T: IntoIterator<Item = ExternalMemoryTypeFlags>>(
    &mut self,
    iterator: T
)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<ExternalImageMemoryType> for ExternalMemoryTypeFlags

fn from(external_memory_type: ExternalImageMemoryType) -> Self

Performs the conversion.

impl From<ExternalMemoryType> for ExternalMemoryTypeFlags

fn from(external_memory_type: ExternalMemoryType) -> Self

Performs the conversion.

impl FromIterator<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

fn from_iter<T: IntoIterator<Item = ExternalMemoryTypeFlags>>(
    iterator: T
) -> ExternalMemoryTypeFlags

Creates a value from an iterator.

impl Hash for ExternalMemoryTypeFlags

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 LowerHex for ExternalMemoryTypeFlags

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

Formats the value using the given formatter.

impl Not for ExternalMemoryTypeFlags

fn not(self) -> ExternalMemoryTypeFlags

Returns the complement of this set of flags.

type Output = ExternalMemoryTypeFlags

The resulting type after applying the ! operator.

impl Octal for ExternalMemoryTypeFlags

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

Formats the value using the given formatter.

impl Ord for ExternalMemoryTypeFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

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

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

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

This method tests for !=.

impl PartialOrd<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

fn sub(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags

Returns the set difference of the two sets of flags.

type Output = ExternalMemoryTypeFlags

The resulting type after applying the - operator.

impl SubAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags

fn sub_assign(&mut self, other: ExternalMemoryTypeFlags)

Disables all flags enabled in the set.

impl UpperHex for ExternalMemoryTypeFlags

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

Formats the value using the given formatter.

impl Copy for ExternalMemoryTypeFlags

impl Eq for ExternalMemoryTypeFlags

impl StructuralEq for ExternalMemoryTypeFlags

impl StructuralPartialEq for ExternalMemoryTypeFlags