Skip to content

Commit a052419

Browse files
njrousselnjroussel
committed
Set rawconstant order in documentation, regenerate documentation
1 parent 358bb51 commit a052419

File tree

4 files changed

+1042
-826
lines changed

4 files changed

+1042
-826
lines changed

‎docs/generate_plugin_doc.py

+1
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@
7878
'srgb',
7979
'd65',
8080
'blackbody'
81+
'rawconstant'
8182
]
8283

8384
SAMPLER_ORDERING = [

‎docs/generated/extracted_rst_api.rst

+100-39
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
Parameter ``sensor`` (:py:obj:`mitsuba.Sensor`):
3636
*no description available*
3737

38-
Parameter ``seed`` (int):
38+
Parameter ``seed`` (drjit.llvm.ad.UInt):
3939
*no description available*
4040

4141
Parameter ``spp`` (int):
@@ -55,7 +55,7 @@
5555
Parameter ``sensor`` (:py:obj:`mitsuba.Sensor`):
5656
*no description available*
5757

58-
Parameter ``seed`` (int):
58+
Parameter ``seed`` (drjit.llvm.ad.UInt):
5959
*no description available*
6060

6161
Parameter ``spp`` (int):
@@ -2736,7 +2736,7 @@
27362736

27372737
.. py:data:: mitsuba.DEBUG
27382738
:type: bool
2739-
:value: False
2739+
:value: True
27402740

27412741
.. py:class:: mitsuba.DefaultFormatter
27422742

@@ -5166,15 +5166,15 @@
51665166

51675167
Overloaded function.
51685168

5169-
1. ``render(self, scene: :py:obj:`mitsuba.Scene`, sensor: :py:obj:`mitsuba.Sensor`, seed: int = 0, spp: int = 0, develop: bool = True, evaluate: bool = True) -> drjit.llvm.ad.TensorXf``
5169+
1. ``render(self, scene: :py:obj:`mitsuba.Scene`, sensor: :py:obj:`mitsuba.Sensor`, seed: drjit.llvm.ad.UInt = 0, spp: int = 0, develop: bool = True, evaluate: bool = True) -> drjit.llvm.ad.TensorXf``
51705170

51715171
Render the scene
51725172

51735173
This function renders the scene from the viewpoint of ``sensor``. All
51745174
other parameters are optional and control different aspects of the
51755175
rendering process. In particular:
51765176

5177-
Parameter ``seed`` (int):
5177+
Parameter ``seed`` (drjit.llvm.ad.UInt):
51785178
This parameter controls the initialization of the random number
51795179
generator. It is crucial that you specify different seeds (e.g.,
51805180
an increasing sequence) if subsequent ``render``() calls should
@@ -5200,7 +5200,7 @@
52005200
(``develop=true``) or modified film (``develop=false``) represent
52015201
the rendering task as an unevaluated computation graph.
52025202

5203-
2. ``render(self, scene: :py:obj:`mitsuba.Scene`, sensor: int = 0, seed: int = 0, spp: int = 0, develop: bool = True, evaluate: bool = True) -> drjit.llvm.ad.TensorXf``
5203+
2. ``render(self, scene: :py:obj:`mitsuba.Scene`, sensor: int = 0, seed: drjit.llvm.ad.UInt = 0, spp: int = 0, develop: bool = True, evaluate: bool = True) -> drjit.llvm.ad.TensorXf``
52045204

52055205
Render the scene
52065206

@@ -5744,7 +5744,7 @@
57445744

57455745
.. py:data:: mitsuba.MI_VERSION
57465746
:type: str
5747-
:value: 3.6.2
5747+
:value: 3.6.4
57485748

57495749
.. py:data:: mitsuba.MI_VERSION_MAJOR
57505750
:type: int
@@ -5756,7 +5756,7 @@
57565756

57575757
.. py:data:: mitsuba.MI_VERSION_PATCH
57585758
:type: int
5759-
:value: 2
5759+
:value: 4
57605760

57615761
.. py:data:: mitsuba.MI_YEAR
57625762
:type: str
@@ -7394,7 +7394,7 @@
73947394
Parameter ``other`` (:py:obj:`mitsuba.Mesh`):
73957395
*no description available*
73967396

7397-
Returns → ref<mitsuba::Mesh<drjit::DiffArray<(JitBackend)2, float>, mitsuba::Color<drjit::DiffArray<(JitBackend)2, float>, 3ul>>>:
7397+
Returns → ref<mitsuba::Mesh<drjit::DiffArray<(JitBackend)2, float>, mitsuba::Color<drjit::DiffArray<(JitBackend)2, float>, 3ul> > >:
73987398
*no description available*
73997399

74007400
.. py:method:: mitsuba.Mesh.opposite_dedge(self, index, active=True)
@@ -7435,6 +7435,20 @@
74357435
Returns → None:
74367436
*no description available*
74377437

7438+
.. py:method:: mitsuba.Mesh.remove_attribute(self, name)
7439+
7440+
Remove an attribute with the given ``name``.
7441+
7442+
Affects both mesh and texture attributes.
7443+
7444+
Throws an exception if the attribute was not previously registered.
7445+
7446+
Parameter ``name`` (str):
7447+
*no description available*
7448+
7449+
Returns → None:
7450+
*no description available*
7451+
74387452
.. py:method:: mitsuba.Mesh.vertex_count()
74397453

74407454
Return the total number of vertices
@@ -8026,7 +8040,7 @@
80268040
filter that spans multiple pixels, the denoiser might identify some
80278041
local variance as a feature of the scene and will not denoise it.
80288042

8029-
.. py:method:: __init__(self, input_size, albedo=False, normals=False, temporal=False)
8043+
.. py:method:: __init__(self, input_size, albedo=False, normals=False, temporal=False, denoise_alpha=False)
80308044

80318045
Constructs an OptiX denoiser
80328046

@@ -8035,35 +8049,36 @@
80358049

80368050
Parameter ``albedo`` (bool):
80378051
Whether or not albedo information will also be given to the
8038-
denoiser.
8052+
denoiser. This parameter is optional, by default it is false.
80398053

80408054
Parameter ``normals`` (bool):
80418055
Whether or not shading normals information will also be given to
8042-
the Denoiser.
8056+
the denoiser. This parameter is optional, by default it is false.
8057+
8058+
Parameter ``temporal`` (bool):
8059+
Whether or not temporal information will also be given to the
8060+
denoiser. This parameter is optional, by default it is false.
8061+
8062+
Parameter ``denoise_alpha`` (bool):
8063+
Whether or not the alpha channel (if specified in the noisy input)
8064+
should be denoised too. This parameter is optional, by default it
8065+
is false.
80438066

80448067
Returns:
80458068
A callable object which will apply the OptiX denoiser.
80468069

8047-
Parameter ``temporal`` (bool):
8048-
*no description available*
8049-
80508070

8051-
.. py:method:: mitsuba.OptixDenoiser.__call__(self, noisy, denoise_alpha=True, albedo, normals, to_sensor=None, flow, previous_denoised)
8071+
.. py:method:: mitsuba.OptixDenoiser.__call__(self, noisy, albedo, normals, to_sensor=None, flow, previous_denoised)
80528072

80538073
Overloaded function.
80548074

8055-
1. ``__call__(self, noisy: drjit.llvm.ad.TensorXf, denoise_alpha: bool = True, albedo: drjit.llvm.ad.TensorXf, normals: drjit.llvm.ad.TensorXf, to_sensor: object | None = None, flow: drjit.llvm.ad.TensorXf, previous_denoised: drjit.llvm.ad.TensorXf) -> drjit.llvm.ad.TensorXf``
8075+
1. ``__call__(self, noisy: drjit.llvm.ad.TensorXf, albedo: drjit.llvm.ad.TensorXf, normals: drjit.llvm.ad.TensorXf, to_sensor: object | None = None, flow: drjit.llvm.ad.TensorXf, previous_denoised: drjit.llvm.ad.TensorXf) -> drjit.llvm.ad.TensorXf``
80568076

80578077
Apply denoiser on inputs which are TensorXf objects.
80588078

80598079
Parameter ``noisy`` (drjit.llvm.ad.TensorXf):
80608080
The noisy input. (tensor shape: (width, height, 3 | 4))
80618081

8062-
Parameter ``denoise_alpha`` (bool):
8063-
Whether or not the alpha channel (if specified in the noisy input)
8064-
should be denoised too. This parameter is optional, by default it
8065-
is true.
8066-
80678082
Parameter ``albedo`` (drjit.llvm.ad.TensorXf):
80688083
Albedo information of the noisy rendering. This parameter is
80698084
optional unless the OptixDenoiser was built with albedo support.
@@ -8101,7 +8116,7 @@
81018116
Returns → drjit.llvm.ad.TensorXf:
81028117
The denoised input.
81038118

8104-
2. ``__call__(self, noisy: :py:obj:`mitsuba.Bitmap`, denoise_alpha: bool = True, albedo_ch: str = '', normals_ch: str = '', to_sensor: object | None = None, flow_ch: str = '', previous_denoised_ch: str = '', noisy_ch: str = '<root>') -> :py:obj:`mitsuba.Bitmap```
8119+
2. ``__call__(self, noisy: :py:obj:`mitsuba.Bitmap`, albedo_ch: str = '', normals_ch: str = '', to_sensor: object | None = None, flow_ch: str = '', previous_denoised_ch: str = '', noisy_ch: str = '<root>') -> :py:obj:`mitsuba.Bitmap```
81058120

81068121
Apply denoiser on inputs which are Bitmap objects.
81078122

@@ -8110,11 +8125,6 @@
81108125
or normals to the denoiser, this Bitmap object must be a
81118126
MultiChannel bitmap.
81128127

8113-
Parameter ``denoise_alpha`` (bool):
8114-
Whether or not the alpha channel (if specified in the noisy input)
8115-
should be denoised too. This parameter is optional, by default it
8116-
is true.
8117-
81188128
Parameter ``albedo_ch``:
81198129
The name of the channel in the ``noisy`` parameter which contains
81208130
the albedo information of the noisy rendering. This parameter is
@@ -9988,7 +9998,7 @@
99889998
Parameter ``sensor`` (:py:obj:`mitsuba.Sensor`):
99899999
*no description available*
999010000

9991-
Parameter ``seed`` (int):
10001+
Parameter ``seed`` (drjit.llvm.ad.UInt):
999210002
*no description available*
999310003

999410004
Parameter ``spp`` (int):
@@ -10008,7 +10018,7 @@
1000810018
Parameter ``sensor`` (:py:obj:`mitsuba.Sensor`):
1000910019
*no description available*
1001010020

10011-
Parameter ``seed`` (int):
10021+
Parameter ``seed`` (drjit.llvm.ad.UInt):
1001210022
*no description available*
1001310023

1001410024
Parameter ``spp`` (int):
@@ -12713,6 +12723,25 @@
1271312723

1271412724
Forward declaration for `SilhouetteSample`
1271512725

12726+
.. py:method:: mitsuba.Shape.add_texture_attribute(self, name, texture)
12727+
12728+
Add a texture attribute with the given ``name``.
12729+
12730+
If an attribute with the same name already exists, it is replaced.
12731+
12732+
Note that ``Mesh`` shapes can additionally handle per-vertex and per-
12733+
face attributes via the ``Mesh::add_attribute`` method.
12734+
12735+
Parameter ``name`` (str):
12736+
Name of the attribute
12737+
12738+
Parameter ``texture`` (:py:obj:`mitsuba.Texture`):
12739+
Texture to store. The dimensionality of the attribute is simply
12740+
the channel count of the texture.
12741+
12742+
Returns → None:
12743+
*no description available*
12744+
1271612745
.. py:method:: mitsuba.Shape.bbox()
1271712746

1271812747
Overloaded function.
@@ -13186,6 +13215,18 @@
1318613215
Returns → drjit.llvm.ad.Bool:
1318713216
*no description available*
1318813217

13218+
.. py:method:: mitsuba.Shape.remove_attribute(self, name)
13219+
13220+
Remove a texture texture with the given ``name``.
13221+
13222+
Throws an exception if the attribute was not registered.
13223+
13224+
Parameter ``name`` (str):
13225+
*no description available*
13226+
13227+
Returns → None:
13228+
*no description available*
13229+
1318913230
.. py:method:: mitsuba.Shape.sample_direction(self, it, sample, active=True)
1319013231

1319113232
Sample a direction towards this shape with respect to solid angles
@@ -13294,6 +13335,16 @@
1329413335
Returns → :py:obj:`mitsuba.Sensor`:
1329513336
*no description available*
1329613337

13338+
.. py:method:: mitsuba.Shape.set_bsdf(self, bsdf)
13339+
13340+
Set the shape's BSDF
13341+
13342+
Parameter ``bsdf`` (:py:obj:`mitsuba.BSDF`):
13343+
*no description available*
13344+
13345+
Returns → None:
13346+
*no description available*
13347+
1329713348
.. py:method:: mitsuba.Shape.shape_type()
1329813349

1329913350
Returns the shape type ShapeType of this shape
@@ -13327,6 +13378,16 @@
1332713378
Returns → drjit.llvm.ad.Float:
1332813379
*no description available*
1332913380

13381+
.. py:method:: mitsuba.Shape.texture_attribute(self, name)
13382+
13383+
Return the texture attribute associated with ``name``.
13384+
13385+
Parameter ``name`` (str):
13386+
*no description available*
13387+
13388+
Returns → :py:obj:`mitsuba.Texture`:
13389+
*no description available*
13390+
1333013391
.. py:class:: mitsuba.ShapePtr
1333113392

1333213393
.. py:method:: mitsuba.ShapePtr.bsdf()
@@ -16821,7 +16882,7 @@
1682116882
Creates a transformation that converts from 'frame' to the standard
1682216883
basis
1682316884

16824-
Parameter ``frame`` (mitsuba::Frame<drjit::DiffArray<(JitBackend)2, double>>):
16885+
Parameter ``frame`` (mitsuba::Frame<drjit::DiffArray<(JitBackend)2, double> >):
1682516886
*no description available*
1682616887

1682716888
Returns → :py:obj:`mitsuba.Transform4d`:
@@ -16934,7 +16995,7 @@
1693416995
Creates a transformation that converts from the standard basis to
1693516996
'frame'
1693616997

16937-
Parameter ``frame`` (mitsuba::Frame<drjit::DiffArray<(JitBackend)2, double>>):
16998+
Parameter ``frame`` (mitsuba::Frame<drjit::DiffArray<(JitBackend)2, double> >):
1693816999
*no description available*
1693917000

1694017001
Returns → :py:obj:`mitsuba.Transform4d`:
@@ -18060,15 +18121,15 @@
1806018121

1806118122
Overloaded function.
1806218123

18063-
1. ``render(self, scene: :py:obj:`mitsuba.Scene`, sensor: :py:obj:`mitsuba.Sensor`, seed: int = 0, spp: int = 0, develop: bool = True, evaluate: bool = True) -> drjit.llvm.ad.TensorXf``
18124+
1. ``render(self, scene: :py:obj:`mitsuba.Scene`, sensor: :py:obj:`mitsuba.Sensor`, seed: drjit.llvm.ad.UInt = 0, spp: int = 0, develop: bool = True, evaluate: bool = True) -> drjit.llvm.ad.TensorXf``
1806418125

1806518126
Render the scene
1806618127

1806718128
This function renders the scene from the viewpoint of ``sensor``. All
1806818129
other parameters are optional and control different aspects of the
1806918130
rendering process. In particular:
1807018131

18071-
Parameter ``seed`` (int):
18132+
Parameter ``seed`` (drjit.llvm.ad.UInt):
1807218133
This parameter controls the initialization of the random number
1807318134
generator. It is crucial that you specify different seeds (e.g.,
1807418135
an increasing sequence) if subsequent ``render``() calls should
@@ -18094,7 +18155,7 @@
1809418155
(``develop=true``) or modified film (``develop=false``) represent
1809518156
the rendering task as an unevaluated computation graph.
1809618157

18097-
2. ``render(self, scene: :py:obj:`mitsuba.Scene`, sensor: int = 0, seed: int = 0, spp: int = 0, develop: bool = True, evaluate: bool = True) -> drjit.llvm.ad.TensorXf``
18158+
2. ``render(self, scene: :py:obj:`mitsuba.Scene`, sensor: int = 0, seed: drjit.llvm.ad.UInt = 0, spp: int = 0, develop: bool = True, evaluate: bool = True) -> drjit.llvm.ad.TensorXf``
1809818159

1809918160
Render the scene
1810018161

@@ -18122,7 +18183,7 @@
1812218183
Parameter ``sensor`` (:py:obj:`mitsuba.Sensor`):
1812318184
*no description available*
1812418185

18125-
Parameter ``seed`` (int):
18186+
Parameter ``seed`` (drjit.llvm.ad.UInt):
1812618187
*no description available*
1812718188

1812818189
Parameter ``spp`` (int):
@@ -18145,7 +18206,7 @@
1814518206
Parameter ``sensor`` (:py:obj:`mitsuba.Sensor`):
1814618207
*no description available*
1814718208

18148-
Parameter ``seed`` (int):
18209+
Parameter ``seed`` (drjit.llvm.ad.UInt):
1814918210
*no description available*
1815018211

1815118212
Parameter ``spp`` (int):
@@ -18390,7 +18451,7 @@
1839018451
Parameter ``sensor`` (:py:obj:`mitsuba.Sensor`):
1839118452
*no description available*
1839218453

18393-
Parameter ``seed`` (int):
18454+
Parameter ``seed`` (drjit.llvm.ad.UInt):
1839418455
*no description available*
1839518456

1839618457
Parameter ``spp`` (int):
@@ -18413,7 +18474,7 @@
1841318474
Parameter ``sensor`` (:py:obj:`mitsuba.Sensor`):
1841418475
*no description available*
1841518476

18416-
Parameter ``seed`` (int):
18477+
Parameter ``seed`` (drjit.llvm.ad.UInt):
1841718478
*no description available*
1841818479

1841918480
Parameter ``spp`` (int):

0 commit comments

Comments
 (0)