Trait renderdoc::api::RenderDocV100 [−] [src]

pub trait RenderDocV100: Sized {
    unsafe fn entry_v100(&self) -> &EntryV100;

    fn get_api_version(&self) -> (u32, u32, u32) { ... }

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

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

    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) { ... }

    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) { ... }

    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 { ... }

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

Base implementation of API version 1.0.0.

Required Methods

Returns the raw EntryV100 entry point struct.

Provided Methods

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

Note that RenderDoc will usually provide a higher API version than the one requested by the user if it's backwards compatible.

Examples

let (major, minor, patch) = renderdoc.get_api_version();
assert_eq!(major, 1u32);
assert_eq!(minor, 0u32);

Sets the specified CaptureOption to the given f32 value.

Panics

This method will panic if the option and/or the value are invalid.

Sets the specified CaptureOption to the given u32 value.

Panics

This method will panic if the option and/or the value are invalid.

Attempts to shut down RenderDoc.

Safety

Note that this will work correctly if done immediately after the dynamic library is loaded, before any API work happens. At that point, RenderDoc will remove its injected hooks and shut down. Behavior is undefined if this is called after any API functions have been called.

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

Data is saved to a capture log file at the location specified via set_log_file_path_template().

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

Examples

if renderdoc.is_frame_capturing() {
    println!("Frames are being captured.");
} else {
    println!("No frame capture is occurring.");
}

Implementors