Struct GpuRenderStageEvent

pub struct GpuRenderStageEvent {

    pub event_id: Option<u64>,
    pub duration: Option<u64>,
    pub hw_queue_iid: Option<u64>,
    pub stage_iid: Option<u64>,
    pub gpu_id: Option<i32>,
    pub context: Option<u64>,
    pub render_target_handle: Option<u64>,
    pub submission_id: Option<u32>,
    pub extra_data: Vec<ExtraData>,
    pub render_pass_handle: Option<u64>,
    pub render_subpass_index_mask: Vec<u64>,
    pub command_buffer_handle: Option<u64>,
    pub specifications: Option<Specifications>,
    pub hw_queue_id: Option<i32>,
    pub stage_id: Option<i32>,
}

next id: 15

Fields

event_id: Option<u64>

required. Unique ID for the event.

duration: Option<u64>

optional. Duration of the event in nanoseconds. If unset, this is a single time point event.

hw_queue_iid: Option<u64>

required. ID to a hardware queue description in the specifications. InternedGpuRenderStageSpecification

stage_iid: Option<u64>

required. ID to a render stage description in the specifications. InternedGpuRenderStageSpecification

gpu_id: Option<i32>

optional. Identifier for GPU in a multi-gpu device.

context: Option<u64>

required. Graphics context for the event. For OpenGL, this is the GL context. For Vulkan, this is the VkDevice.

render_target_handle: Option<u64>

optional. The render target for this event. For OpenGL, this is the GL frame buffer handle. For Vulkan, this is the VkFrameBuffer handle.

submission_id: Option<u32>

optional. Submission ID generated by the UMD. For OpenGL, the ID should map to an API submission (e.g., glFlush, glFinish, eglSwapBufffers) event. The set of submissions to the HW due to a single API submission should share the same ID. For Vulkan, it should map 1:1 with a vkQueueSubmit.

extra_data: Vec<ExtraData>

render_pass_handle: Option<u64>

optional. The Vulkan render pass handle.

render_subpass_index_mask: Vec<u64>

optional. A bit mask representing which render subpasses contributed to this render stage event. Subpass index 0 is represented by setting the LSB of the mask. Additional mask can be added for subpass index greater than 63.

command_buffer_handle: Option<u64>

optional. The Vulkan command buffer handle.

specifications: Option<Specifications>

👎Deprecated

Deprecated. Use hw_queue_iid and stage_iid to refer to InternedGpuRenderStageSpecification instead.

hw_queue_id: Option<i32>

👎Deprecated

Deprecated. Use hw_queue_iid instead;

stage_id: Option<i32>

👎Deprecated

Deprecated. Use stage_iid instead;

Implementations

impl GpuRenderStageEvent

pub fn event_id(&self) -> u64

Returns the value of event_id, or the default value if event_id is unset.

pub fn duration(&self) -> u64

Returns the value of duration, or the default value if duration is unset.

pub fn hw_queue_id(&self) -> i32

Returns the value of hw_queue_id, or the default value if hw_queue_id is unset.

pub fn stage_id(&self) -> i32

Returns the value of stage_id, or the default value if stage_id is unset.

pub fn context(&self) -> u64

Returns the value of context, or the default value if context is unset.

pub fn render_target_handle(&self) -> u64

Returns the value of render_target_handle, or the default value if render_target_handle is unset.

pub fn render_pass_handle(&self) -> u64

Returns the value of render_pass_handle, or the default value if render_pass_handle is unset.

pub fn submission_id(&self) -> u32

Returns the value of submission_id, or the default value if submission_id is unset.

pub fn gpu_id(&self) -> i32

Returns the value of gpu_id, or the default value if gpu_id is unset.

pub fn command_buffer_handle(&self) -> u64

Returns the value of command_buffer_handle, or the default value if command_buffer_handle is unset.

pub fn hw_queue_iid(&self) -> u64

Returns the value of hw_queue_iid, or the default value if hw_queue_iid is unset.

pub fn stage_iid(&self) -> u64

Returns the value of stage_iid, or the default value if stage_iid is unset.

Trait Implementations

impl Clone for GpuRenderStageEvent

fn clone(&self) -> GpuRenderStageEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GpuRenderStageEvent

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

Formats the value using the given formatter.

impl Default for GpuRenderStageEvent

fn default() -> Self

Returns the “default value” for a type.

impl Message for GpuRenderStageEvent

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for GpuRenderStageEvent

fn eq(&self, other: &GpuRenderStageEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GpuRenderStageEvent