Enum CaptureOption

#[repr(u32)]
pub enum CaptureOption {
    AllowVSync = 0,
    AllowFullscreen = 1,
    ApiValidation = 2,
    CaptureCallstacks = 3,
    CaptureCallstacksOnlyDraws = 4,
    DelayForDebugger = 5,
    VerifyMapWrites = 6,
    HookIntoChildren = 7,
    RefAllResources = 8,
    SaveAllInitials = 9,
    CaptureAllCmdLists = 10,
    DebugOutputMute = 11,
    AllowUnsupportedVendorExtensions = 12,
}

RenderDoc capture options.

Variants

AllowVSync = 0

Let the application enable vertical synchronization.

AllowFullscreen = 1

Let the application enter fullscreen mode.

ApiValidation = 2

Record API debugging events and messages.

This option also goes by the deprecated name of DebugDeviceMode.

CaptureCallstacks = 3

Capture CPU callstacks for API events.

CaptureCallstacksOnlyDraws = 4

When capturing CPU callstacks, only capture them from drawcalls.

This option does nothing without the above option being enabled.

DelayForDebugger = 5

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

VerifyMapWrites = 6

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

HookIntoChildren = 7

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

RefAllResources = 8

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 = 9

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 = 10

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 = 11

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

AllowUnsupportedVendorExtensions = 12

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 duplicate of the value.

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

Performs copy-assignment from source.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CaptureOption

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CaptureOption

impl Eq for CaptureOption

impl StructuralPartialEq for CaptureOption