Struct renderdoc::RenderDoc
[−]
[src]
pub struct RenderDoc<V: ApiVersion>(_);
An instance of the RenderDoc API with baseline version V
.
Methods
impl<V: ApiVersion> RenderDoc<V>
[src]
fn new() -> Result<RenderDoc<V>, String>
[src]
Initializes a new instance of the RenderDoc API.
unsafe fn raw_api(&self) -> V::Entry
[src]
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,
[src]
V::Entry: Clone,
fn clone(&self) -> RenderDoc<V>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<V: Debug + ApiVersion> Debug for RenderDoc<V> where
V::Entry: Debug,
[src]
V::Entry: Debug,
impl From<RenderDoc<V110>> for RenderDoc<V100>
[src]
impl RenderDocV100 for RenderDoc<V100>
[src]
unsafe fn entry_v100(&self) -> &EntryV100
[src]
Returns the raw EntryV100
entry point struct.
fn get_api_version(&self) -> (u32, u32, u32)
[src]
Provides the major, minor, and patch version numbers of the RenderDoc API given to the application. Read more
fn set_capture_option_f32(&mut self, opt: CaptureOption, val: f32)
[src]
Sets the specified CaptureOption
to the given f32
value. Read more
fn set_capture_option_u32(&mut self, opt: CaptureOption, val: u32)
[src]
Sets the specified CaptureOption
to the given u32
value. Read more
fn get_capture_option_f32(&self, opt: CaptureOption) -> f32
[src]
fn get_capture_option_u32(&self, opt: CaptureOption) -> u32
[src]
fn set_capture_keys<I: Into<InputButton> + Clone>(&mut self, keys: &[I])
[src]
fn set_focus_toggle_keys<I: Into<InputButton> + Clone>(&mut self, keys: &[I])
[src]
unsafe fn shutdown(self)
[src]
Attempts to shut down RenderDoc. Read more
fn unload_crash_handler(&mut self)
[src]
fn get_overlay_bits(&self) -> OverlayBits
[src]
fn mask_overlay_bits(&mut self, and: OverlayBits, or: OverlayBits)
[src]
fn get_log_file_path_template(&self) -> &str
[src]
fn set_log_file_path_template<P: AsRef<Path>>(&mut self, path_template: P)
[src]
fn get_num_captures(&self) -> u32
[src]
fn get_capture(&self, index: u32) -> Option<(String, u64)>
[src]
fn trigger_capture(&mut self)
[src]
Captures the next frame from the currently active window and API device. Read more
fn is_target_control_connected(&self) -> bool
[src]
fn launch_replay_ui<C>(&self, cmd_line: C) -> Result<u32, ()> where
C: Into<Option<&'static str>>,
[src]
C: Into<Option<&'static str>>,
fn set_active_window<D>(&mut self, dev: D, win: WindowHandle) where
D: Into<DevicePointer>,
[src]
D: Into<DevicePointer>,
fn start_frame_capture<D>(&mut self, dev: D, win: WindowHandle) where
D: Into<DevicePointer>,
[src]
D: Into<DevicePointer>,
fn is_frame_capturing(&self) -> bool
[src]
Returns whether or not a frame capture is currently ongoing anywhere. Read more
fn end_frame_capture<D>(&mut self, dev: D, win: WindowHandle) where
D: Into<DevicePointer>,
[src]
D: Into<DevicePointer>,
impl RenderDocV100 for RenderDoc<V110>
[src]
unsafe fn entry_v100(&self) -> &EntryV100
[src]
Returns the raw EntryV100
entry point struct.
fn get_api_version(&self) -> (u32, u32, u32)
[src]
Provides the major, minor, and patch version numbers of the RenderDoc API given to the application. Read more
fn set_capture_option_f32(&mut self, opt: CaptureOption, val: f32)
[src]
Sets the specified CaptureOption
to the given f32
value. Read more
fn set_capture_option_u32(&mut self, opt: CaptureOption, val: u32)
[src]
Sets the specified CaptureOption
to the given u32
value. Read more
fn get_capture_option_f32(&self, opt: CaptureOption) -> f32
[src]
fn get_capture_option_u32(&self, opt: CaptureOption) -> u32
[src]
fn set_capture_keys<I: Into<InputButton> + Clone>(&mut self, keys: &[I])
[src]
fn set_focus_toggle_keys<I: Into<InputButton> + Clone>(&mut self, keys: &[I])
[src]
unsafe fn shutdown(self)
[src]
Attempts to shut down RenderDoc. Read more
fn unload_crash_handler(&mut self)
[src]
fn get_overlay_bits(&self) -> OverlayBits
[src]
fn mask_overlay_bits(&mut self, and: OverlayBits, or: OverlayBits)
[src]
fn get_log_file_path_template(&self) -> &str
[src]
fn set_log_file_path_template<P: AsRef<Path>>(&mut self, path_template: P)
[src]
fn get_num_captures(&self) -> u32
[src]
fn get_capture(&self, index: u32) -> Option<(String, u64)>
[src]
fn trigger_capture(&mut self)
[src]
Captures the next frame from the currently active window and API device. Read more
fn is_target_control_connected(&self) -> bool
[src]
fn launch_replay_ui<C>(&self, cmd_line: C) -> Result<u32, ()> where
C: Into<Option<&'static str>>,
[src]
C: Into<Option<&'static str>>,
fn set_active_window<D>(&mut self, dev: D, win: WindowHandle) where
D: Into<DevicePointer>,
[src]
D: Into<DevicePointer>,
fn start_frame_capture<D>(&mut self, dev: D, win: WindowHandle) where
D: Into<DevicePointer>,
[src]
D: Into<DevicePointer>,
fn is_frame_capturing(&self) -> bool
[src]
Returns whether or not a frame capture is currently ongoing anywhere. Read more
fn end_frame_capture<D>(&mut self, dev: D, win: WindowHandle) where
D: Into<DevicePointer>,
[src]
D: Into<DevicePointer>,
impl RenderDocV110 for RenderDoc<V110>
[src]
unsafe fn entry_v110(&self) -> &EntryV110
[src]
Returns the raw EntryV110
entry point struct.
fn trigger_multi_frame_capture(&self, num_frames: u32)
[src]
Captures the next n frames from the currently active window and API device. Read more