Struct thin_engine::prelude::draw_parameters::SamplesPassedQuery

pub struct SamplesPassedQuery { /* private fields */ }

A query that allows you to know the number of samples written to the output during the draw operations where this query was active.

If you just want to know whether or not some samples have been written, you should use a AnySamplesPassedQuery query instead.

Implementations

impl SamplesPassedQuery

pub fn new<F>(facade: &F) -> Result<SamplesPassedQuery, QueryCreationError>

where F: Facade + ?Sized,

Builds a new query.

impl SamplesPassedQuery

pub fn is_ready(&self) -> bool

Queries the counter to see if the result is already available.

pub fn get(self) -> u32

Returns the value of the query. Blocks until it is available.

This function doesn’t block if is_ready would return true.

Note that you are strongly discouraged from calling this in the middle of the rendering process, as it may block for a long time.

Queries should either have their result written into a buffer, be used for conditional rendering, or stored and checked during the next frame.

pub fn to_buffer_u32( &self, target: BufferSlice<'_, u32>, ) -> Result<(), ToBufferError>

Writes the result of the query to a buffer when it is available.

This function doesn’t block. Instead it submits a commands to the GPU’s commands queue and orders the GPU to write the result of the query to a buffer.

This operation is not necessarily supported everywhere.

Trait Implementations

impl Debug for SamplesPassedQuery

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

Formats the value using the given formatter.

impl<'a> From<&'a SamplesPassedQuery> for SamplesQueryParam<'a>

fn from(r: &'a SamplesPassedQuery) -> SamplesQueryParam<'a>

Converts to this type from the input type.

impl GlObject for SamplesPassedQuery

type Id = u32

The type of identifier for this object.

fn get_id(&self) -> u32

Returns the id of the object.