Module: RenderDoc

Defined in:
lib/renderdoc/native/generated.rb,
lib/renderdoc.rb,
lib/renderdoc/errors.rb,
lib/renderdoc/native.rb,
lib/renderdoc/capture.rb,
lib/renderdoc/version.rb,
lib/renderdoc/settings.rb,
lib/renderdoc/application.rb,
lib/renderdoc/configuration.rb,
lib/renderdoc/frame_trigger.rb,
lib/renderdoc/rspec_integration.rb

Overview

Generated from RenderDoc's renderdoc_app.h by script/generate_native_api.rb. Source: RenderDoc v1.25, RENDERDOC_API_1_6_0. Do not edit by hand.

Defined Under Namespace

Modules: Native, RSpecIntegration, Settings Classes: Application, Capture, CaptureError, Configuration, Error, FrameTrigger, NotAttachedError, VersionError

Constant Summary collapse

VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

.api_version ⇒ Object 



17
 
# File 'lib/renderdoc.rb', line 17

def api_version = application.api_version

.available? ⇒ Boolean

Returns:

  • (Boolean) 


16
 
# File 'lib/renderdoc.rb', line 16

def available? = application.available?

.capture(**arguments, &block) ⇒ Object 



18
 
# File 'lib/renderdoc.rb', line 18

def capture(**arguments, &block) = application.capture(**arguments, &block)

.capture_keys=(keys) ⇒ Object 



37
38
39
 
# File 'lib/renderdoc.rb', line 37

def capture_keys=(keys)
  application.capture_keys = keys
end

.capture_path_template ⇒ Object 



20
 
# File 'lib/renderdoc.rb', line 20

def capture_path_template = application.capture_path_template

.capture_path_template=(path) ⇒ Object 



21
22
23
 
# File 'lib/renderdoc.rb', line 21

def capture_path_template=(path)
  application.capture_path_template = path
end

.captures ⇒ Object 



24
 
# File 'lib/renderdoc.rb', line 24

def captures = application.captures

.comments=(comments) ⇒ Object 



28
29
30
 
# File 'lib/renderdoc.rb', line 28

def comments=(comments)
  application.comments = comments
end

.configure(unavailable: nil) {|configuration| ... } ⇒ Object

Yields:

  • (configuration) 


10
11
12
13
14
 
# File 'lib/renderdoc.rb', line 10

def configure(unavailable: nil)
  configuration.unavailable_behavior = unavailable if unavailable
  yield configuration if block_given?
  configuration
end

.focus_toggle_keys=(keys) ⇒ Object 



41
42
43
 
# File 'lib/renderdoc.rb', line 41

def focus_toggle_keys=(keys)
  application.focus_toggle_keys = keys
end

.launch_replay_ui(**arguments) ⇒ Object 



25
 
# File 'lib/renderdoc.rb', line 25

def launch_replay_ui(**arguments) = application.launch_replay_ui(**arguments)

.option(name, value) ⇒ Object 



44
 
# File 'lib/renderdoc.rb', line 44

def option(name, value) = application.option(name, value)

.option_value(name, type: :uint32) ⇒ Object 



45
 
# File 'lib/renderdoc.rb', line 45

def option_value(name, type: :uint32) = application.option_value(name, type: type)

.overlay ⇒ Object 



32
 
# File 'lib/renderdoc.rb', line 32

def overlay = application.overlay

.overlay=(enabled) ⇒ Object 



33
34
35
 
# File 'lib/renderdoc.rb', line 33

def overlay=(enabled)
  application.overlay = enabled
end

.set_capture_comments(comments, path: nil) ⇒ Object 



31
 
# File 'lib/renderdoc.rb', line 31

def set_capture_comments(comments, path: nil) = application.set_capture_comments(comments, path: path)

.show_replay_ui ⇒ Object 



27
 
# File 'lib/renderdoc.rb', line 27

def show_replay_ui = application.show_replay_ui

.target_control_connected? ⇒ Boolean

Returns:

  • (Boolean) 


26
 
# File 'lib/renderdoc.rb', line 26

def target_control_connected? = application.target_control_connected?

.trigger_capture(frames: 1) ⇒ Object 



19
 
# File 'lib/renderdoc.rb', line 19

def trigger_capture(frames: 1) = application.trigger_capture(frames: frames)