Enum renderdoc::CaptureOption [−][src]
#[repr(u32)]pub enum CaptureOption { AllowVSync, AllowFullscreen, ApiValidation, CaptureCallstacks, CaptureCallstacksOnlyDraws, DelayForDebugger, VerifyMapWrites, HookIntoChildren, RefAllResources, SaveAllInitials, CaptureAllCmdLists, DebugOutputMute, }
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.
Trait Implementations
impl Clone for CaptureOption
[src]
impl Clone for CaptureOption
fn clone(&self) -> CaptureOption
[src]
fn clone(&self) -> CaptureOption
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Copy for CaptureOption
[src]
impl Copy for CaptureOption
impl Debug for CaptureOption
[src]
impl Debug for CaptureOption
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Eq for CaptureOption
[src]
impl Eq for CaptureOption
impl Hash for CaptureOption
[src]
impl Hash for CaptureOption
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl PartialEq for CaptureOption
[src]
impl PartialEq for CaptureOption
Auto Trait Implementations
impl Send for CaptureOption
impl Send for CaptureOption
impl Sync for CaptureOption
impl Sync for CaptureOption