:py:mod:`rtgs.ray_tracer`
=========================

.. py:module:: rtgs.ray_tracer

.. autodoc2-docstring:: rtgs.ray_tracer
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`RayTracer <rtgs.ray_tracer.RayTracer>`
     - .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer
          :summary:

API
~~~

.. py:class:: RayTracer(buf_size: rtgs.utils.types.vec2i, scene: rtgs.scene.Scene, camera: rtgs.camera.Camera)
   :canonical: rtgs.ray_tracer.RayTracer

   .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer

   .. rubric:: Initialization

   .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.__init__

   .. py:attribute:: scene
      :canonical: rtgs.ray_tracer.RayTracer.scene
      :type: rtgs.scene.Scene
      :value: None

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.scene

   .. py:attribute:: camera
      :canonical: rtgs.ray_tracer.RayTracer.camera
      :type: rtgs.camera.Camera
      :value: None

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.camera

   .. py:attribute:: sample_buf
      :canonical: rtgs.ray_tracer.RayTracer.sample_buf
      :type: taichi.Field
      :value: None

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.sample_buf

   .. py:attribute:: attenuation_buf
      :canonical: rtgs.ray_tracer.RayTracer.attenuation_buf
      :type: taichi.Field
      :value: None

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.attenuation_buf

   .. py:attribute:: num_steps
      :canonical: rtgs.ray_tracer.RayTracer.num_steps
      :type: taichi.i32
      :value: None

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.num_steps

   .. py:attribute:: num_samples
      :canonical: rtgs.ray_tracer.RayTracer.num_samples
      :type: taichi.i32
      :value: None

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.num_samples

   .. py:attribute:: disp_buf
      :canonical: rtgs.ray_tracer.RayTracer.disp_buf
      :type: taichi.Field
      :value: None

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.disp_buf

   .. py:method:: sample(depth: int)
      :canonical: rtgs.ray_tracer.RayTracer.sample

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.sample

   .. py:method:: clear_sample()
      :canonical: rtgs.ray_tracer.RayTracer.clear_sample

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.clear_sample

   .. py:method:: clear_attenuation()
      :canonical: rtgs.ray_tracer.RayTracer.clear_attenuation

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.clear_attenuation

   .. py:method:: generate_disp_buffer(num_samples: taichi.i32, num_steps: taichi.i32, num_depth: taichi.i32)
      :canonical: rtgs.ray_tracer.RayTracer.generate_disp_buffer

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.generate_disp_buffer

   .. py:method:: sample_step()
      :canonical: rtgs.ray_tracer.RayTracer.sample_step

      .. autodoc2-docstring:: rtgs.ray_tracer.RayTracer.sample_step