mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-04 17:10:47 +00:00
Update documentation to reference new descriptor APIs
This commit is contained in:
@@ -33,12 +33,12 @@ For the purposes of this example we use the API abstraction :py:class:`~renderdo
|
||||
# Get the pixel shader's reflection object
|
||||
ps = state.GetShaderReflection(rd.ShaderStage.Pixel)
|
||||
|
||||
cb = state.GetConstantBuffer(rd.ShaderStage.Pixel, 0, 0)
|
||||
cb = state.GetConstantBlock(rd.ShaderStage.Pixel, 0, 0)
|
||||
|
||||
print("Pixel shader:")
|
||||
print(controller.DisassembleShader(pipe, ps.reflection, target))
|
||||
|
||||
Now we want to display the constants bound to this shader. Shader bindings is an area that diverges quite a lot between the APIs, and RenderDoc's abstraction over this is detailed in :py:class:`~renderdoc.BindPointMap`. For now, we'll simply select the first constant buffer in this shader and fetch the constants for it with :py:meth:`~renderdoc.ReplayController.GetCBufferVariableContents`.
|
||||
Now we want to display the constants bound to this shader. Shader bindings is an area that diverges quite a lot between the APIs, and RenderDoc's abstraction over this is detailed in :ref:`more detail <descriptor-abstraction>`. For now, we'll simply select the first constant buffer in this shader and fetch the constants for it with :py:meth:`~renderdoc.ReplayController.GetCBufferVariableContents`.
|
||||
|
||||
.. highlight:: python
|
||||
.. code:: python
|
||||
|
||||
@@ -35,13 +35,7 @@ Vertex Inputs
|
||||
Shader Resource Bindings
|
||||
------------------------
|
||||
|
||||
.. autoclass:: renderdoc.BoundResourceArray
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.BoundResource
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.BoundCBuffer
|
||||
.. autoclass:: renderdoc.UsedDescriptor
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.BindType
|
||||
@@ -53,9 +47,6 @@ Shader Resource Bindings
|
||||
.. autoclass:: renderdoc.TextureSwizzle4
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.D3DBufferViewFlags
|
||||
:members:
|
||||
|
||||
Samplers
|
||||
--------
|
||||
|
||||
|
||||
@@ -29,15 +29,6 @@ Shaders and Bindings
|
||||
.. autoclass:: D3D11Shader
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11ConstantBuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11Sampler
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11View
|
||||
:members:
|
||||
|
||||
Stream-out
|
||||
----------
|
||||
|
||||
|
||||
@@ -8,21 +8,6 @@ D3D12 Pipeline State
|
||||
.. autoclass:: D3D12State
|
||||
:members:
|
||||
|
||||
Root Signature and Bindings
|
||||
---------------------------
|
||||
|
||||
.. autoclass:: D3D12RootSignatureRange
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12ConstantBuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12Sampler
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12View
|
||||
:members:
|
||||
|
||||
Vertex Input
|
||||
------------
|
||||
|
||||
|
||||
@@ -26,27 +26,15 @@ Shader
|
||||
.. autoclass:: GLShader
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLTextureCompleteness
|
||||
:members:
|
||||
|
||||
Fixed Vertex Processing
|
||||
-----------------------
|
||||
|
||||
.. autoclass:: GLFixedVertexProcessing
|
||||
:members:
|
||||
|
||||
Shader Bindings
|
||||
---------------
|
||||
|
||||
.. autoclass:: GLTexture
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLSampler
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLBuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLImageLoadStore
|
||||
:members:
|
||||
|
||||
Transform Feedback
|
||||
------------------
|
||||
|
||||
@@ -80,9 +68,6 @@ Framebuffer
|
||||
.. autoclass:: GLFBO
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLAttachment
|
||||
:members:
|
||||
|
||||
Blending
|
||||
--------
|
||||
|
||||
|
||||
@@ -17,10 +17,7 @@ Pipeline and Bindings
|
||||
.. autoclass:: VKDescriptorSet
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKDescriptorBinding
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKBindingElement
|
||||
.. autoclass:: VKDynamicOffset
|
||||
:members:
|
||||
|
||||
Vertex Input
|
||||
@@ -110,9 +107,6 @@ Renderpass and Framebuffer
|
||||
.. autoclass:: VKFramebuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKAttachment
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKRenderArea
|
||||
:members:
|
||||
|
||||
|
||||
@@ -5,16 +5,37 @@ Shaders
|
||||
|
||||
.. currentmodule:: renderdoc
|
||||
|
||||
Bindpoints
|
||||
----------
|
||||
Descriptors
|
||||
-----------
|
||||
|
||||
.. autoclass:: renderdoc.ShaderBindpointMapping
|
||||
.. autoclass:: renderdoc.Descriptor
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.Bindpoint
|
||||
.. autoclass:: renderdoc.SamplerDescriptor
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.BindpointIndex
|
||||
.. autoclass:: renderdoc.DescriptorFlags
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.DescriptorCategory
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.DescriptorType
|
||||
:members:
|
||||
|
||||
.. autofunction:: renderdoc.CategoryForDescriptorType
|
||||
.. autofunction:: renderdoc.IsConstantBlockDescriptor
|
||||
.. autofunction:: renderdoc.IsReadOnlyDescriptor
|
||||
.. autofunction:: renderdoc.IsReadWriteDescriptor
|
||||
.. autofunction:: renderdoc.IsSamplerDescriptor
|
||||
|
||||
.. autoclass:: renderdoc.DescriptorLogicalLocation
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.DescriptorRange
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.DescriptorAccess
|
||||
:members:
|
||||
|
||||
Reflection
|
||||
@@ -30,6 +51,7 @@ Reflection
|
||||
:members:
|
||||
|
||||
.. autofunction:: renderdoc.MaskForStage
|
||||
.. autofunction:: renderdoc.FirstStageForMask
|
||||
|
||||
.. autoclass:: renderdoc.SigParameter
|
||||
:members:
|
||||
@@ -142,3 +164,5 @@ Shader Variables
|
||||
.. autoclass:: renderdoc.PointerVal
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.ShaderBindIndex
|
||||
:members:
|
||||
|
||||
Reference in New Issue
Block a user