Struct vulkano::sync::Event [] [src]

pub struct Event { /* fields omitted */ }

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.

Methods

impl Event
[src]

[src]

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.

[src]

Builds a new event.

[src]

Returns true if the event is signaled.

[src]

See the docs of set().

[src]

Changes the Event to the signaled state.

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

Panic

  • Panics if the device or host ran out of memory.

[src]

See the docs of reset().

[src]

Changes the Event to the unsignaled state.

Panic

  • Panics if the device or host ran out of memory.

Trait Implementations

impl Debug for Event
[src]

[src]

Formats the value using the given formatter. Read more

impl DeviceOwned for Event
[src]

[src]

Returns the device that owns Self.

impl VulkanObject for Event
[src]

The type of the object.

TYPE: DebugReportObjectTypeEXT = vk::DEBUG_REPORT_OBJECT_TYPE_EVENT_EXT

The DebugReportObjectTypeEXT of the internal Vulkan handle.

[src]

Returns a reference to the object.

impl Drop for Event
[src]

[src]

Executes the destructor for this type. Read more

Auto Trait Implementations

impl Send for Event

impl Sync for Event