Struct vulkano::sync::event::Event

pub struct Event { /* private fields */ }

Used to block the GPU execution until an event on the CPU occurs.

Note that Vulkan implementations may have limits on how long a command buffer will wait for an event to be signaled, in order to avoid interfering with progress of other clients of the GPU. If the event isn’t signaled within these limits, results are undefined and may include device loss.

Implementations

impl Event

pub fn new( device: Arc<Device>, create_info: EventCreateInfo ) -> Result<Event, Validated<VulkanError>>

Creates a new Event.

On portability subset devices, the events feature must be enabled on the device.

pub fn from_pool(device: Arc<Device>) -> Result<Event, VulkanError>

Takes an event from the vulkano-provided event pool. If the pool is empty, a new event will be allocated. Upon drop, the event is put back into the pool.

For most applications, using the event pool should be preferred, in order to avoid creating new events every frame.

pub unsafe fn from_handle( device: Arc<Device>, handle: Event, create_info: EventCreateInfo ) -> Event

Creates a new Event from a raw object handle.

Safety

• handle must be a valid Vulkan object handle created from device.
• create_info must match the info used to create the object.

pub fn flags(&self) -> EventCreateFlags

Returns the flags that the event was created with.

pub fn is_signaled(&self) -> Result<bool, Validated<VulkanError>>

Returns true if the event is signaled.

pub fn set(&mut self) -> Result<(), Validated<VulkanError>>

Changes the Event to the signaled state.

If a command buffer is waiting on this event, it is then unblocked.

pub unsafe fn reset(&mut self) -> Result<(), Validated<VulkanError>>

Changes the Event to the unsignaled state.

Safety

• There must be an execution dependency between reset and the execution of any
  wait_events command that includes this event in its events parameter.

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.

impl DeviceOwned for Event

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

Returns the device that owns self.

impl Drop for Event

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for Event

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

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 Event

type Handle = Event

The type of the object.

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

Returns the raw Vulkan handle of the object.

impl Eq for Event