Struct GameCaptureSourceBuilder 

pub struct GameCaptureSourceBuilder { /* private fields */ }

Available on Windows only.

A source to capture a game or fullscreen application.

Use GameCaptureSourceBuilder::get_windows to get a list of windows that can be captured (feature window-list needs to be enabled). Requires OBS to be running with administrator privileges to capture certain games.

Important Notice

This source fails to capture if another instance (OBS studio, another instance of your program, etc.) has a game capture source for the same game/application active. If the window can be captured can be checked using GameCaptureSourceBuilder::is_window_in_use_by_other_instance (feature window-list needs to be enabled).

Implementations

impl GameCaptureSourceBuilder

pub fn set_capture_mode(self, capture_mode: ObsGameCaptureMode) -> Self

Sets the capture mode for the game capture source. Look at doc for ObsGameCaptureMode

pub fn set_window_raw<T: Into<ObsString> + Sync + Send>( self, window_raw: T, ) -> Self

Sets the window to capture.

Arguments

• window - The window to capture, represented as ObsString. Must be in the format of an obs window id

Returns

The updated WindowCaptureSourceBuilder instance.

pub fn set_priority(self, priority: ObsWindowPriority) -> Self

Window Match Priority

pub fn set_sli_compatability(self, sli_compatability: bool) -> Self

SLI/Crossfire Capture Mode (Slow)

pub fn set_capture_cursor(self, capture_cursor: bool) -> Self

Whether the cursor should be captured

pub fn set_allow_transparency(self, allow_transparency: bool) -> Self

If transparency of windows should be allowed

pub fn set_premultiplied_alpha(self, premultiplied_alpha: bool) -> Self

Premultiplied Alpha

pub fn set_limit_framerate(self, limit_framerate: bool) -> Self

Limit capture framerate

pub fn set_capture_overlays(self, capture_overlays: bool) -> Self

Capture third party overlays (such as steam overlays)

pub fn set_anti_cheat_hook(self, anti_cheat_hook: bool) -> Self

Use anti-cheat compatibility hook

pub fn set_hook_rate(self, hook_rate: ObsHookRate) -> Self

Hook rate (Ranging from slow to fastest)

pub fn set_rgb10a2_space(self, rgb10a2_space: ObsGameCaptureRgbaSpace) -> Self

The color space to capture in

impl GameCaptureSourceBuilder

pub fn get_windows( mode: WindowSearchMode, ) -> Result<Vec<WindowInfo>, ObsSimpleError>

Gets a list of windows that can be captured by this source.

pub fn is_window_in_use_by_other_instance(window_pid: u32) -> Result<bool>

Checks if a window with the given process ID can be captured by this source. This does not guarantee that the window can be captured, only that it is not black

pub fn set_window(self, window: &WindowInfo) -> Self

Sets the window to capture.

Arguments

• window - The window to capture. A list of available windows can be retrieved using GameCaptureSourceBuilder::get_windows

Returns

The updated GameCaptureSourceBuilder instance.

impl GameCaptureSourceBuilder

pub fn set_capture_audio( self, capture_audio: bool, ) -> Result<Self, ObsSimpleError>

Trait Implementations

impl Debug for GameCaptureSourceBuilder

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

Formats the value using the given formatter.

impl ObsObjectBuilder for GameCaptureSourceBuilder

fn new<T: Into<ObsString> + Send + Sync>( name: T, runtime: ObsRuntime, ) -> Result<Self, ObsError>

fn runtime(&self) -> &ObsRuntime

fn get_settings(&self) -> &ObsData

fn get_settings_updater(&mut self) -> &mut ObsDataUpdater

fn get_hotkeys(&self) -> &ObsData

fn get_hotkeys_updater(&mut self) -> &mut ObsDataUpdater

fn get_name(&self) -> ObsString

Returns the name of the source.

fn get_id() -> ObsString

Returns the ID of the source.

fn object_build(self) -> Result<ObjectInfo, ObsError>

impl ObsSourceBuilder for GameCaptureSourceBuilder

type T = GameCaptureSource

fn build(self) -> Result<Self::T, ObsError>

where Self: Sized,

fn add_to_scene( self, scene: &mut ObsSceneRef, ) -> Result<ObsSceneItemRef<Self::T>, ObsError>

where Self: Sized,

Both items are returned: the source and the scene item it was added as. You can safely drop these items, they are stored within the scene if you don’t need them.