Enum renderdoc::CaptureOption

#[repr(u32)]
pub enum CaptureOption {
    AllowVSync,
    AllowFullscreen,
    ApiValidation,
    CaptureCallstacks,
    CaptureCallstacksOnlyDraws,
    DelayForDebugger,
    VerifyMapWrites,
    HookIntoChildren,
    RefAllResources,
    SaveAllInitials,
    CaptureAllCmdLists,
    DebugOutputMute,
    AllowUnsupportedVendorExtensions,
}

RenderDoc capture options.

Variants

AllowVSync

Let the application enable vertical synchronization.

AllowFullscreen

Let the application enter fullscreen mode.

ApiValidation

Record API debugging events and messages.

This option also goes by the deprecated name of DebugDeviceMode.

CaptureCallstacks

Capture CPU callstacks for API events.

CaptureCallstacksOnlyDraws

When capturing CPU callstacks, only capture them from drawcalls.

This option does nothing without the above option being enabled.

DelayForDebugger

Specify a delay, measured in seconds, to wait for a debugger to attach to the application after being injected.

VerifyMapWrites

Verify any writes to mapped buffers by checking the memory after the bounds of the returned pointer to detect any modification.

HookIntoChildren

Hooks any system API calls that create child processes and injects RenderDoc into them recursively with the same options.

RefAllResources

Reference all resources available at the time of capture.

By default, RenderDoc only includes resources in the final capture file necessary for that frame. This option allows you to override that behavior.

SaveAllInitials

Save the initial state for all resources, regardless of usage.

By default, RenderDoc skips saving initial states for resources where the previous contents don't appear to be used (assuming that writes before reads indicate the previous contents aren't used).

CaptureAllCmdLists

Capture all command lists generated from the start of the application.

In APIs that allow for recording of command lists to be replayed later, RenderDoc may choose to not capture command lists before a frame capture is triggered to reduce overhead. This means any command lists that are recorded one and replayed many times will not be available, potentially causing a failure to capture.

Note that this is only true for APIs where multithreading is difficult or otherwise discouraged. Newer APIs, e.g. Vulkan and D3D12, will ignore this option and always capture all command lists since they are heavily oriented around them and the associated overhead is mostly reduced due to superior API design.

DebugOutputMute

Mute API debug output when CaptureOption::ApiValidation is enabled.

AllowUnsupportedVendorExtensions

Allow all vendor extensions to be used, even when they may be incompatible with RenderDoc and could potentially cause corrupted replays or crashes.

Trait Implementations

impl Clone for CaptureOption

fn clone(&self) -> CaptureOption

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for CaptureOption

impl Copy for CaptureOption

impl PartialEq<CaptureOption> for CaptureOption

fn eq(&self, other: &CaptureOption) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for CaptureOption

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

Formats the value using the given formatter.

impl Hash for CaptureOption

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].