Class: Stagecraft::Renderer

Inherits:
Object
  • Object
show all
Defined in:
lib/stagecraft/renderer/frame.rb,
lib/stagecraft/renderer/stats.rb,
lib/stagecraft/renderer/shaders.rb,
lib/stagecraft/renderer/features.rb,
lib/stagecraft/renderer/renderer.rb,
lib/stagecraft/renderer/gpu_context.rb,
lib/stagecraft/renderer/render_list.rb,
lib/stagecraft/renderer/pipeline_cache.rb,
lib/stagecraft/renderer/resource_cache.rb,
lib/stagecraft/renderer/uniform_packer.rb,
lib/stagecraft/renderer/frame_resources.rb,
lib/stagecraft/renderer/pipeline_factory.rb,
lib/stagecraft/renderer/wgpu_compatibility.rb

Defined Under Namespace

Modules: Features, Shaders, WGPUCompatibility Classes: Frame, FrameResources, GPUContext, PipelineCache, PipelineFactory, RenderList, ResourceCache, Stats, UniformPacker

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(window: nil, width: 800, height: 600, msaa: 4, device: nil, queue: nil, surface: nil, backend: nil) ⇒ Renderer

Returns a new instance of Renderer.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/stagecraft/renderer/renderer.rb', line 11

def initialize(window: nil, width: 800, height: 600, msaa: 4, device: nil, queue: nil,
               surface: nil, backend: nil)
  @backend = backend
  @window = window
  @width = Integer(width)
  @height = Integer(height)
  @sample_count = Integer(msaa)
  @stats = Stats.new
  @after_render_callbacks = []
  @disposed = false
  @start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  return if backend

  @context = GPUContext.new(window:, width:, height:, device:, queue:, surface:)
  @device = @context.device
  @queue = @context.queue
  @surface_format = @context.surface_format
  @resources = FrameResources.new(context: @context, stats:, sample_count:)
  @sample_count = @resources.sample_count
  @resource_cache = ResourceCache.new(device: @device, queue: @queue, stats:)
  @pipelines = PipelineFactory.new(
    device: @device, queue: @queue, resources: @resources, resource_cache: @resource_cache,
    stats:, sample_count: @sample_count
  )
  create_post_resources
rescue StandardError
  dispose_after_failed_initialization
  raise
end

Instance Attribute Details

#device ⇒ Object (readonly)

Returns the value of attribute device.



5
6
7
 
# File 'lib/stagecraft/renderer/renderer.rb', line 5

def device
  @device
end

#height ⇒ Object (readonly)

Returns the value of attribute height.



5
6
7
 
# File 'lib/stagecraft/renderer/renderer.rb', line 5

def height
  @height
end

#queue ⇒ Object (readonly)

Returns the value of attribute queue.



5
6
7
 
# File 'lib/stagecraft/renderer/renderer.rb', line 5

def queue
  @queue
end

#sample_count ⇒ Object (readonly)

Returns the value of attribute sample_count.



5
6
7
 
# File 'lib/stagecraft/renderer/renderer.rb', line 5

def sample_count
  @sample_count
end

#stats ⇒ Object (readonly)

Returns the value of attribute stats.



5
6
7
 
# File 'lib/stagecraft/renderer/renderer.rb', line 5

def stats
  @stats
end

#surface_format ⇒ Object (readonly)

Returns the value of attribute surface_format.



5
6
7
 
# File 'lib/stagecraft/renderer/renderer.rb', line 5

def surface_format
  @surface_format
end

#width ⇒ Object (readonly)

Returns the value of attribute width.



5
6
7
 
# File 'lib/stagecraft/renderer/renderer.rb', line 5

def width
  @width
end

Class Method Details

.offscreen(width:, height:, msaa: 1, **options) ⇒ Object 



7
8
9
 
# File 'lib/stagecraft/renderer/renderer.rb', line 7

def self.offscreen(width:, height:, msaa: 1, **options)
  new(width:, height:, msaa:, **options)
end

Instance Method Details

#dispose ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/stagecraft/renderer/renderer.rb', line 101

def dispose
  return self if @disposed

  @disposed = true
  first_error = nil
  [
    -> { warn_live_resources },
    -> { release_post_resources },
    -> { @pipelines&.dispose },
    -> { @resource_cache&.dispose_all },
    -> { @resources&.dispose },
    -> { @context&.dispose }
  ].each do |cleanup|
    cleanup.call
  rescue StandardError => error
    first_error ||= error
  end
  raise first_error if first_error

  self
end

#disposed? ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/stagecraft/renderer/renderer.rb', line 123

def disposed?
  @disposed
end

#on_after_render(&block) ⇒ Object 



96
97
98
99
 
# File 'lib/stagecraft/renderer/renderer.rb', line 96

def on_after_render(&block)
  @after_render_callbacks << block
  self
end

#render(scene, camera) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/stagecraft/renderer/renderer.rb', line 41

def render(scene, camera)
  ensure_alive!
  resize_from_window
  list = RenderList.new(scene, camera)
  update_stats(list)
  if @backend
    frame = record_frame(list, camera)
    report_debug_stats
    return frame
  end

  light, light_vp = shadow_light_and_matrix(list)
  @resources.resize_shadow(light.shadow.map_size) if light
  ordered_items = list.items
  @resources.begin_frame(
    ordered_items,
    camera:,
    ambient: list.ambient,
    lights: prioritized_lights(list.lights, light),
    light_vp:,
    time: elapsed_time
  )
  encoder = device.create_command_encoder(label: "stagecraft frame")
  encode_shadow_pass(encoder, light ? ordered_items : [])
  encode_main_pass(encoder, ordered_items, scene)
  @after_render_callbacks.each { |callback| callback.call(encoder, @resources.hdr_view) }
  target_texture, target_view = @resources.frame_target
  encode_post_pass(encoder, target_view)
  queue.submit([encoder.finish])
  @context.present
  @resource_cache.advance_frame
  frame = Frame.new(
    texture: target_texture,
    width:,
    height:,
    device:,
    queue:,
    readable: @context.surface.nil?
  )
  report_debug_stats
  frame
end

#resize(width, height) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/stagecraft/renderer/renderer.rb', line 84

def resize(width, height)
  ensure_alive!
  @width = [Integer(width), 1].max
  @height = [Integer(height), 1].max
  return self if @backend
  return self unless @context.resize(@width, @height)

  @resources.resize(@width, @height)
  create_post_resources
  self
end