Struct ObsSceneItemHandle 

pub struct ObsSceneItemHandle { /* private fields */ }

Type-erased managed scene-item handle used when libobs itself replaces a native item, such as during group ungrouping. Ordinary source insertion still returns ObsSceneItemRef<T>.

Trait Implementations

impl Clone for ObsSceneItemHandle

fn clone(&self) -> ObsSceneItemHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObsSceneItemHandle

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

Formats the value using the given formatter.

impl SceneItemTrait for ObsSceneItemHandle

fn runtime(&self) -> ObsRuntime

fn object_id(&self) -> NativeObjectId

fn remove_from_scene(&self) -> Result<(), ObsError>

Removes this item from its scene immediately while keeping the typed handle valid until its final Rust reference is dropped. Repeated calls are harmless.

fn is_removed(&self) -> bool

Whether this item has been explicitly removed from its scene.

fn get_transform_info(&self) -> Result<ObsTransformInfo, ObsError>

Gets the transform info of the given source in this scene.

fn get_source_position(&self) -> Result<Vec2, ObsError>

Gets the position of the given source in this scene.

fn get_source_scale(&self) -> Result<Vec2, ObsError>

Gets the scale of the given source in this scene.

fn set_source_position(&self, position: Vec2) -> Result<(), ObsError>

Sets the position of the given source in this scene.

fn set_transform_info(&self, info: &ObsTransformInfo) -> Result<(), ObsError>

Sets the transform info of the given source in this scene. The ObsTransformInfo can be built by using the ObsTransformInfoBuilder.

fn fit_source_to_screen(&self) -> Result<bool, ObsError>

Fits the given source to the screen size. If the source is locked, no action is taken.

fn is_visible(&self) -> Result<bool, ObsError>

Returns whether the item is visible.

fn crop(&self) -> Result<ObsSceneItemCrop, ObsError>

Returns the explicit pixel crop applied to this scene item.

fn set_crop(&self, crop: ObsSceneItemCrop) -> Result<(), ObsError>

Replaces the explicit left/top/right/bottom pixel crop for this scene item. Negative edge values are clamped to zero by libobs.

fn set_visible(&self, visible: bool) -> Result<(), ObsError>

Shows or hides the item.

fn is_locked(&self) -> Result<bool, ObsError>

Returns whether the item transform is locked.

fn set_locked(&self, locked: bool) -> Result<(), ObsError>

Locks or unlocks the item transform.

fn rotation(&self) -> Result<f32, ObsError>

Returns the clockwise rotation in degrees.

fn set_rotation(&self, degrees: f32) -> Result<(), ObsError>

Sets the clockwise rotation in degrees.

fn order_position(&self) -> Result<i32, ObsError>

Returns the item’s zero-based order position within its scene.

fn set_order_position(&self, position: i32) -> Result<(), ObsError>

Moves the item to an absolute order position within its scene.

fn move_order(&self, movement: ObsOrderMovement) -> Result<(), ObsError>

Moves the item relative to the other items in its scene.

fn scale_filter(&self) -> Result<ObsScaleType, ObsError>

Returns the scaling filter used when this item is resized.

fn set_scale_filter(&self, filter: ObsScaleType) -> Result<(), ObsError>

fn blend_method(&self) -> Result<ObsBlendMethod, ObsError>

fn set_blend_method(&self, method: ObsBlendMethod) -> Result<(), ObsError>

fn blend_mode(&self) -> Result<ObsBlendMode, ObsError>

fn set_blend_mode(&self, mode: ObsBlendMode) -> Result<(), ObsError>

fn transform_snapshot(&self) -> Result<ObsSceneItemTransformSnapshot, ObsError>

Captures every transform-affecting scene-item property exposed by libobs.

fn apply_transform_snapshot( &self, snapshot: &ObsSceneItemTransformSnapshot, ) -> Result<(), ObsError>

Restores a transform snapshot through the same managed actor seam as individual setters.

fn state_snapshot(&self) -> Result<ObsSceneItemStateSnapshot, ObsError>

fn apply_state_snapshot( &self, snapshot: &ObsSceneItemStateSnapshot, ) -> Result<(), ObsError>

fn position(&self) -> Result<Vec2, ObsError>

Preferred shorthand for SceneItemTrait::get_source_position.

fn set_position(&self, position: Vec2) -> Result<(), ObsError>

Preferred shorthand for SceneItemTrait::set_source_position.

fn scale(&self) -> Result<Vec2, ObsError>

Preferred shorthand for SceneItemTrait::get_source_scale.

fn set_scale(&self, scale: Vec2) -> Result<(), ObsError>

Preferred shorthand for SceneItemTrait::set_source_scale.

fn set_source_scale(&self, scale: Vec2) -> Result<(), ObsError>

Sets the scale of the given source in this scene.