Struct vulkano::query::QueryResultFlags

pub struct QueryResultFlags {
    pub wait: bool,
    pub with_availability: bool,
    pub partial: bool,
    pub _ne: NonExhaustive,
}

Flags to control how the results of a query should be retrieved.

VK_QUERY_RESULT_64_BIT is not included, as it is determined automatically via the QueryResultElement trait.

Fields

wait: bool

Wait for the results to become available before writing the results.

with_availability: bool

Write an additional element to the end of each query’s results, indicating the availability of the results:

• Nonzero: The results are available, and have been written to the element(s) preceding.
• Zero: The results are not yet available, and have not been written.

partial: bool

Allow writing partial results to the buffer, instead of waiting until they are fully available.

_ne: NonExhaustive

Implementations

impl QueryResultFlags

pub const fn empty() -> Self

Returns a QueryResultFlags with none of the flags set.

pub const fn none() -> Self

👎Deprecated since 0.31.0: Use empty instead.

Returns a QueryResultFlags with none of the flags set.

pub const fn is_empty(&self) -> bool

Returns whether no flags are set in self.

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

Returns whether any flags are set in both self and other.

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

Returns whether all flags in other are set in self.

pub const fn union(&self, other: &Self) -> Self

Returns the union of self and other.

pub const fn intersection(&self, other: &Self) -> Self

Returns the intersection of self and other.

pub const fn difference(&self, other: &Self) -> Self

Returns self without the flags set in other.

pub const fn symmetric_difference(&self, other: &Self) -> Self

Returns the flags set in self or other, but not both.

Trait Implementations

impl BitAnd<QueryResultFlags> for QueryResultFlags

type Output = QueryResultFlags

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self

Performs the & operation.

impl BitAndAssign<QueryResultFlags> for QueryResultFlags

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<QueryResultFlags> for QueryResultFlags

type Output = QueryResultFlags

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl BitOrAssign<QueryResultFlags> for QueryResultFlags

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<QueryResultFlags> for QueryResultFlags

type Output = QueryResultFlags

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation.

impl BitXorAssign<QueryResultFlags> for QueryResultFlags

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for QueryResultFlags

fn clone(&self) -> QueryResultFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryResultFlags

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

Formats the value using the given formatter.

impl Default for QueryResultFlags

fn default() -> Self

Returns the “default value” for a type.

impl From<QueryResultFlags> for QueryResultFlags

fn from(val: QueryResultFlags) -> Self

Converts to this type from the input type.

impl From<QueryResultFlags> for QueryResultFlags

fn from(val: QueryResultFlags) -> Self

Converts to this type from the input type.

impl Hash for QueryResultFlags

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

fn eq(&self, other: &QueryResultFlags) -> 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 Sub<QueryResultFlags> for QueryResultFlags

type Output = QueryResultFlags

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl SubAssign<QueryResultFlags> for QueryResultFlags

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for QueryResultFlags

impl Eq for QueryResultFlags

impl StructuralEq for QueryResultFlags

impl StructuralPartialEq for QueryResultFlags