Struct ndk::hardware_buffer::HardwareBufferUsage
source · pub struct HardwareBufferUsage(/* private fields */);
api-level-26
only.Expand description
Buffer usage flags, specifying how the buffer will be accessed.
Implementations§
source§impl HardwareBufferUsage
impl HardwareBufferUsage
sourcepub const CPU_READ_NEVER: Self = _
pub const CPU_READ_NEVER: Self = _
The buffer will never be locked for direct CPU reads using the
HardwareBuffer::lock()
function. Note that reading the buffer using OpenGL or Vulkan
functions or memory mappings is still allowed.
sourcepub const CPU_READ_RARELY: Self = _
pub const CPU_READ_RARELY: Self = _
The buffer will sometimes be locked for direct CPU reads using the
HardwareBuffer::lock()
function. Note that reading the buffer using OpenGL or Vulkan
functions or memory mappings does not require the presence of this flag.
sourcepub const CPU_READ_OFTEN: Self = _
pub const CPU_READ_OFTEN: Self = _
The buffer will often be locked for direct CPU reads using the
HardwareBuffer::lock()
function. Note that reading the buffer using OpenGL or Vulkan
functions or memory mappings does not require the presence of this flag.
sourcepub const CPU_READ_MASK: Self = _
pub const CPU_READ_MASK: Self = _
CPU read value mask.
sourcepub const CPU_WRITE_NEVER: Self = _
pub const CPU_WRITE_NEVER: Self = _
The buffer will never be locked for direct CPU writes using the
HardwareBuffer::lock()
function. Note that writing the buffer using OpenGL or Vulkan
functions or memory mappings is still allowed.
sourcepub const CPU_WRITE_RARELY: Self = _
pub const CPU_WRITE_RARELY: Self = _
The buffer will sometimes be locked for direct CPU writes using the
HardwareBuffer::lock()
function. Note that writing the buffer using OpenGL or Vulkan
functions or memory mappings does not require the presence of this flag.
sourcepub const CPU_WRITE_OFTEN: Self = _
pub const CPU_WRITE_OFTEN: Self = _
The buffer will often be locked for direct CPU writes using the
HardwareBuffer::lock()
function. Note that writing the buffer using OpenGL or Vulkan
functions or memory mappings does not require the presence of this flag.
sourcepub const CPU_WRITE_MASK: Self = _
pub const CPU_WRITE_MASK: Self = _
CPU write value mask.
sourcepub const GPU_SAMPLED_IMAGE: Self = _
pub const GPU_SAMPLED_IMAGE: Self = _
The buffer will be read from by the GPU as a texture.
sourcepub const GPU_FRAMEBUFFER: Self = _
pub const GPU_FRAMEBUFFER: Self = _
The buffer will be written to by the GPU as a framebuffer attachment.
sourcepub const GPU_COLOR_OUTPUT: Self = _
pub const GPU_COLOR_OUTPUT: Self = _
The buffer will be written to by the GPU as a framebuffer attachment.
Note that the name of this flag is somewhat misleading: it does not imply that the
buffer contains a color format. A buffer with depth or stencil format that will be
used as a framebuffer attachment should also have this flag. Use the equivalent flag
[HardwareBufferusage::GPU_FRAMEBUFFER
] to avoid this confusion.
sourcepub const COMPOSER_OVERLAY: Self = _
pub const COMPOSER_OVERLAY: Self = _
The buffer will be used as a composer HAL overlay layer.
This flag is currently only needed when using [SurfaceTransaction::set_buffer()
] to
set a buffer. In all other cases, the framework adds this flag internally to buffers
that could be presented in a composer overlay. [SurfaceTransaction::set_buffer()
]
is special because it uses buffers allocated directly through
HardwareBuffer::allocate()
instead of buffers allocated by the framework.
sourcepub const PROTECTED_CONTENT: Self = _
pub const PROTECTED_CONTENT: Self = _
The buffer is protected from direct CPU access or being read by non-secure hardware, such as video encoders.
This flag is incompatible with CPU read and write flags. It is mainly used when handling
DRM video. Refer to the EGL extension EGL_EXT_protected_content
and GL extension
GL_EXT_protected_textures
for more information on how these buffers are expected
to behave.
sourcepub const VIDEO_ENCODE: Self = _
pub const VIDEO_ENCODE: Self = _
The buffer will be read by a hardware video encoder.
sourcepub const SENSOR_DIRECT_DATA: Self = _
pub const SENSOR_DIRECT_DATA: Self = _
The buffer will be used for direct writes from sensors. When this flag is present, the
format must be [HardwareBufferFormat::Blob
].
sourcepub const GPU_DATA_BUFFER: Self = _
pub const GPU_DATA_BUFFER: Self = _
The buffer will be used as a shader storage or uniform buffer object. When this flag is
present, the format must be [HardwareBufferFormat::Blob
].
sourcepub const GPU_CUBE_MAP: Self = _
pub const GPU_CUBE_MAP: Self = _
The buffer will be used as a cube map texture. When this flag is present, the buffer
must have a layer count that is a multiple of 6. Note that buffers with this flag must
be bound to OpenGL textures using the extension GL_EXT_EGL_image_storage
instead
of GL_KHR_EGL_image
.
sourcepub const GPU_MIPMAP_COMPLETE: Self = _
pub const GPU_MIPMAP_COMPLETE: Self = _
The buffer contains a complete mipmap hierarchy. Note that buffers with this flag must
be bound to OpenGL textures using the extension GL_EXT_EGL_image_storage
instead
of GL_KHR_EGL_image
.
pub const VENDOR_0: Self = _
pub const VENDOR_1: Self = _
pub const VENDOR_2: Self = _
pub const VENDOR_3: Self = _
pub const VENDOR_4: Self = _
pub const VENDOR_5: Self = _
pub const VENDOR_6: Self = _
pub const VENDOR_7: Self = _
pub const VENDOR_8: Self = _
pub const VENDOR_9: Self = _
pub const VENDOR_10: Self = _
pub const VENDOR_11: Self = _
pub const VENDOR_12: Self = _
pub const VENDOR_13: Self = _
pub const VENDOR_14: Self = _
pub const VENDOR_15: Self = _
pub const VENDOR_16: Self = _
pub const VENDOR_17: Self = _
pub const VENDOR_18: Self = _
pub const VENDOR_19: Self = _
source§impl HardwareBufferUsage
impl HardwareBufferUsage
sourcepub const fn bits(&self) -> u64
pub const fn bits(&self) -> u64
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u64) -> Self
pub const fn from_bits_retain(bits: u64) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl HardwareBufferUsage
impl HardwareBufferUsage
sourcepub const fn iter(&self) -> Iter<HardwareBufferUsage>
pub const fn iter(&self) -> Iter<HardwareBufferUsage>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<HardwareBufferUsage>
pub const fn iter_names(&self) -> IterNames<HardwareBufferUsage>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
source§impl HardwareBufferUsage
impl HardwareBufferUsage
sourcepub fn cpu_read(self) -> HardwareBufferUsage
pub fn cpu_read(self) -> HardwareBufferUsage
Helper to read HardwareBufferUsage::CPU_READ_MASK
values.
sourcepub fn cpu_write(self) -> HardwareBufferUsage
pub fn cpu_write(self) -> HardwareBufferUsage
Helper to read HardwareBufferUsage::CPU_WRITE_MASK
values.
Trait Implementations§
source§impl Binary for HardwareBufferUsage
impl Binary for HardwareBufferUsage
source§impl BitAnd for HardwareBufferUsage
impl BitAnd for HardwareBufferUsage
source§impl BitAndAssign for HardwareBufferUsage
impl BitAndAssign for HardwareBufferUsage
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for HardwareBufferUsage
impl BitOr for HardwareBufferUsage
source§fn bitor(self, other: HardwareBufferUsage) -> Self
fn bitor(self, other: HardwareBufferUsage) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = HardwareBufferUsage
type Output = HardwareBufferUsage
|
operator.source§impl BitOrAssign for HardwareBufferUsage
impl BitOrAssign for HardwareBufferUsage
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for HardwareBufferUsage
impl BitXor for HardwareBufferUsage
source§impl BitXorAssign for HardwareBufferUsage
impl BitXorAssign for HardwareBufferUsage
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for HardwareBufferUsage
impl Clone for HardwareBufferUsage
source§fn clone(&self) -> HardwareBufferUsage
fn clone(&self) -> HardwareBufferUsage
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for HardwareBufferUsage
impl Debug for HardwareBufferUsage
source§impl Extend<HardwareBufferUsage> for HardwareBufferUsage
impl Extend<HardwareBufferUsage> for HardwareBufferUsage
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for HardwareBufferUsage
impl Flags for HardwareBufferUsage
source§const FLAGS: &'static [Flag<HardwareBufferUsage>] = _
const FLAGS: &'static [Flag<HardwareBufferUsage>] = _
source§fn from_bits_retain(bits: u64) -> HardwareBufferUsage
fn from_bits_retain(bits: u64) -> HardwareBufferUsage
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<HardwareBufferUsage> for HardwareBufferUsage
impl FromIterator<HardwareBufferUsage> for HardwareBufferUsage
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for HardwareBufferUsage
impl Hash for HardwareBufferUsage
source§impl IntoIterator for HardwareBufferUsage
impl IntoIterator for HardwareBufferUsage
source§impl LowerHex for HardwareBufferUsage
impl LowerHex for HardwareBufferUsage
source§impl Not for HardwareBufferUsage
impl Not for HardwareBufferUsage
source§impl Octal for HardwareBufferUsage
impl Octal for HardwareBufferUsage
source§impl PartialEq for HardwareBufferUsage
impl PartialEq for HardwareBufferUsage
source§fn eq(&self, other: &HardwareBufferUsage) -> bool
fn eq(&self, other: &HardwareBufferUsage) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for HardwareBufferUsage
impl PublicFlags for HardwareBufferUsage
source§impl Sub for HardwareBufferUsage
impl Sub for HardwareBufferUsage
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = HardwareBufferUsage
type Output = HardwareBufferUsage
-
operator.source§impl SubAssign for HardwareBufferUsage
impl SubAssign for HardwareBufferUsage
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.