Struct cp_tracking_area 

pub struct cp_tracking_area { /* private fields */ }

Available on crate feature tracking_area only.

Apple’s documentation

Implementations

impl cp_tracking_area

pub unsafe fn render_value( tracking_area: cp_tracking_area_t, ) -> cp_tracking_area_render_value

Returns the render value for the tracking area.

• Parameters:
• tracking_area: The tracking area for a frame.
• Returns: The render value for the tracking area for this frame. This value is what should be used in this frames render pass to identify the tracking area of given identifier.

Use the returned value in the render pass of cp_drawable_get_tracking_areas_texture for the pixel value of the tracking area identifier.

Safety

tracking_area must be a valid pointer.

pub unsafe fn identifier( tracking_area: cp_tracking_area_t, ) -> cp_tracking_area_identifier

Returns the identifier for the tracking area.

• Parameters:
• tracking_area: The tracking area for a frame.
• Returns: The identifier for the tracking area. This should be a unique value for this tracking area and consistent for the rendered mesh/object across frames.

Safety

tracking_area must be a valid pointer.

pub unsafe fn add_automatic_hover_effect( tracking_area: cp_tracking_area_t, ) -> cp_hover_effect_t

Returns the hover effect opaque object for the tracking area for this frame.

• Parameters:
• tracking_area: The tracking area for a frame.
• Returns: The hover effect for the tracking area.

The hover effect contains information used to render the hover effect using the tracking area textures and gaze once application render pass has completed. Can only create 1 hover effect per-tracking area, to destroy and disable the hover effect see cp_hover_effect_destroy

Safety

tracking_area must be a valid pointer.

Trait Implementations

impl Debug for cp_tracking_area

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

Formats the value using the given formatter.

impl RefEncode for cp_tracking_area

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.