Struct renderdoc::RenderDoc

pub struct RenderDoc<V: ApiVersion>(_);

An instance of the RenderDoc API with baseline version V.

Methods

impl<V: ApiVersion> RenderDoc<V>

pub fn new() -> Result<RenderDoc<V>, String>

Initializes a new instance of the RenderDoc API.

pub unsafe fn raw_api(&self) -> V::Entry

Returns the raw entry point of the API.

Safety

Using the entry point structure directly will discard any thread safety provided by default with this library.

Trait Implementations

impl<V: Clone + ApiVersion> Clone for RenderDoc<V> where
    V::Entry: Clone, 

fn clone(&self) -> RenderDoc<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug + ApiVersion> Debug for RenderDoc<V> where
    V::Entry: Debug, 

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl From<RenderDoc<V110>> for RenderDoc<V100>

fn from(newer: RenderDoc<V110>) -> RenderDoc<V100>

Performs the conversion.

impl RenderDocV100 for RenderDoc<V100>

unsafe fn entry_v100(&self) -> &EntryV100

Returns the raw EntryV100 entry point struct.

fn get_api_version(&self) -> (u32, u32, u32)

Provides the major, minor, and patch version numbers of the RenderDoc API given to the application.

fn set_capture_option_f32(&mut self, opt: CaptureOption, val: f32)

Sets the specified CaptureOption to the given f32 value.

fn set_capture_option_u32(&mut self, opt: CaptureOption, val: u32)

Sets the specified CaptureOption to the given u32 value.

fn get_capture_option_f32(&self, opt: CaptureOption) -> f32

fn get_capture_option_u32(&self, opt: CaptureOption) -> u32

fn set_capture_keys<I: Into<InputButton> + Clone>(&mut self, keys: &[I])

fn set_focus_toggle_keys<I: Into<InputButton> + Clone>(&mut self, keys: &[I])

unsafe fn shutdown(self)

Attempts to shut down RenderDoc.

fn unload_crash_handler(&mut self)

fn get_overlay_bits(&self) -> OverlayBits

fn mask_overlay_bits(&mut self, and: OverlayBits, or: OverlayBits)

fn get_log_file_path_template(&self) -> &str

fn set_log_file_path_template<P: AsRef<Path>>(&mut self, path_template: P)

fn get_num_captures(&self) -> u32

fn get_capture(&self, index: u32) -> Option<(String, u64)>

fn trigger_capture(&mut self)

Captures the next frame from the currently active window and API device.

fn is_target_control_connected(&self) -> bool

fn launch_replay_ui<C>(&self, cmd_line: C) -> Result<u32, ()> where
    C: Into<Option<&'static str>>, 

fn set_active_window<D>(&mut self, dev: D, win: WindowHandle) where
    D: Into<DevicePointer>, 

fn start_frame_capture<D>(&mut self, dev: D, win: WindowHandle) where
    D: Into<DevicePointer>, 

fn is_frame_capturing(&self) -> bool

Returns whether or not a frame capture is currently ongoing anywhere.

fn end_frame_capture<D>(&mut self, dev: D, win: WindowHandle) where
    D: Into<DevicePointer>, 

impl RenderDocV100 for RenderDoc<V110>

unsafe fn entry_v100(&self) -> &EntryV100

Returns the raw EntryV100 entry point struct.

fn get_api_version(&self) -> (u32, u32, u32)

Provides the major, minor, and patch version numbers of the RenderDoc API given to the application.

fn set_capture_option_f32(&mut self, opt: CaptureOption, val: f32)

Sets the specified CaptureOption to the given f32 value.

fn set_capture_option_u32(&mut self, opt: CaptureOption, val: u32)

Sets the specified CaptureOption to the given u32 value.

fn get_capture_option_f32(&self, opt: CaptureOption) -> f32

fn get_capture_option_u32(&self, opt: CaptureOption) -> u32

fn set_capture_keys<I: Into<InputButton> + Clone>(&mut self, keys: &[I])

fn set_focus_toggle_keys<I: Into<InputButton> + Clone>(&mut self, keys: &[I])

unsafe fn shutdown(self)

Attempts to shut down RenderDoc.

fn unload_crash_handler(&mut self)

fn get_overlay_bits(&self) -> OverlayBits

fn mask_overlay_bits(&mut self, and: OverlayBits, or: OverlayBits)

fn get_log_file_path_template(&self) -> &str

fn set_log_file_path_template<P: AsRef<Path>>(&mut self, path_template: P)

fn get_num_captures(&self) -> u32

fn get_capture(&self, index: u32) -> Option<(String, u64)>

fn trigger_capture(&mut self)

Captures the next frame from the currently active window and API device.

fn is_target_control_connected(&self) -> bool

fn launch_replay_ui<C>(&self, cmd_line: C) -> Result<u32, ()> where
    C: Into<Option<&'static str>>, 

fn set_active_window<D>(&mut self, dev: D, win: WindowHandle) where
    D: Into<DevicePointer>, 

fn start_frame_capture<D>(&mut self, dev: D, win: WindowHandle) where
    D: Into<DevicePointer>, 

fn is_frame_capturing(&self) -> bool

Returns whether or not a frame capture is currently ongoing anywhere.

fn end_frame_capture<D>(&mut self, dev: D, win: WindowHandle) where
    D: Into<DevicePointer>, 

impl RenderDocV110 for RenderDoc<V110>

unsafe fn entry_v110(&self) -> &EntryV110

Returns the raw EntryV110 entry point struct.

fn trigger_multi_frame_capture(&self, num_frames: u32)

Captures the next n frames from the currently active window and API device.