mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-07-13 19:17:12 +00:00
Remove use of automodule in docs
* One automodule in a file for our modules is way too much, so we split it into files. Unfortunately this means that only one file can have those classes and functions be linkable from elsewhere. * Instead we bite the bullet and manually curate the items into pages, and at the same time subdivide the 'enums and data' page more which is a general readability and usability win as well. * We also add some previously not-included functions, and add a doc-build time check to ensure that functions and classes aren't omitted from the documentation in future
This commit is contained in:
baldurk
@@ -1,68 +1,132 @@
|
||||
Common Pipeline State Abstraction
|
||||
=================================
|
||||
|
||||
.. contents::
|
||||
|
||||
.. currentmodule:: renderdoc
|
||||
|
||||
.. autoclass:: PipeState
|
||||
:members:
|
||||
|
||||
Viewport
|
||||
--------
|
||||
|
||||
.. autoclass:: renderdoc.Viewport
|
||||
:members:
|
||||
|
||||
Scissor
|
||||
-------
|
||||
|
||||
.. autoclass:: renderdoc.Scissor
|
||||
:members:
|
||||
|
||||
BlendEquation
|
||||
Vertex Inputs
|
||||
-------------
|
||||
|
||||
.. autoclass:: renderdoc.BlendEquation
|
||||
:members:
|
||||
|
||||
ColorBlend
|
||||
----------
|
||||
|
||||
.. autoclass:: renderdoc.ColorBlend
|
||||
:members:
|
||||
|
||||
StencilFace
|
||||
-----------
|
||||
|
||||
.. autoclass:: renderdoc.StencilFace
|
||||
:members:
|
||||
|
||||
BoundResource
|
||||
-------------
|
||||
|
||||
.. autoclass:: renderdoc.BoundResource
|
||||
:members:
|
||||
|
||||
BoundResourceArray
|
||||
------------------
|
||||
|
||||
.. autoclass:: renderdoc.BoundResourceArray
|
||||
:members:
|
||||
|
||||
BoundVBuffer
|
||||
------------
|
||||
|
||||
.. autoclass:: renderdoc.BoundVBuffer
|
||||
:members:
|
||||
|
||||
BoundCBuffer
|
||||
------------
|
||||
.. autoclass:: renderdoc.VertexInputAttribute
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.Topology
|
||||
:members:
|
||||
|
||||
.. autofunction:: renderdoc.NumVerticesPerPrimitive
|
||||
.. autofunction:: renderdoc.VertexOffset
|
||||
.. autofunction:: renderdoc.PatchList_Count
|
||||
.. autofunction:: renderdoc.PatchList_Topology
|
||||
.. autofunction:: renderdoc.SupportsRestart
|
||||
.. autofunction:: renderdoc.IsStrip
|
||||
|
||||
Shader Resource Bindings
|
||||
------------------------
|
||||
|
||||
.. autoclass:: renderdoc.BoundResourceArray
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.BoundResource
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.BoundCBuffer
|
||||
:members:
|
||||
|
||||
VertexInputAttribute
|
||||
.. autoclass:: renderdoc.BindType
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.TextureSwizzle
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.TextureSwizzle4
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.D3DBufferViewFlags
|
||||
:members:
|
||||
|
||||
Samplers
|
||||
--------
|
||||
|
||||
.. autoclass:: renderdoc.AddressMode
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.TextureFilter
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.FilterMode
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.FilterFunction
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.ChromaSampleLocation
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.YcbcrConversion
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.YcbcrRange
|
||||
:members:
|
||||
|
||||
Viewport and Scissor
|
||||
--------------------
|
||||
|
||||
.. autoclass:: renderdoc.VertexInputAttribute
|
||||
.. autoclass:: renderdoc.Viewport
|
||||
:members:
|
||||
|
||||
|
||||
.. autoclass:: renderdoc.Scissor
|
||||
:members:
|
||||
|
||||
Rasterizer
|
||||
----------
|
||||
|
||||
.. autoclass:: renderdoc.CullMode
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.FillMode
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.ConservativeRaster
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.LineRaster
|
||||
:members:
|
||||
|
||||
|
||||
Stencil
|
||||
-------
|
||||
|
||||
.. autoclass:: renderdoc.StencilFace
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.StencilOperation
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.CompareFunction
|
||||
:members:
|
||||
|
||||
Blending
|
||||
--------
|
||||
|
||||
.. autoclass:: renderdoc.ColorBlend
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.BlendEquation
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.BlendMultiplier
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.BlendOperation
|
||||
:members:
|
||||
|
||||
.. autoclass:: renderdoc.LogicOperation
|
||||
:members:
|
||||
|
||||
|
||||
@@ -1,13 +1,75 @@
|
||||
D3D11 Pipeline State
|
||||
====================
|
||||
|
||||
.. contents::
|
||||
|
||||
.. currentmodule:: renderdoc
|
||||
|
||||
.. autoclass:: D3D11State
|
||||
:members:
|
||||
|
||||
.. automodule:: renderdoc
|
||||
:noindex:
|
||||
Vertex Input
|
||||
------------
|
||||
|
||||
.. autoclass:: D3D11InputAssembly
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11IndexBuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11VertexBuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11Layout
|
||||
:members:
|
||||
|
||||
Shaders and Bindings
|
||||
--------------------
|
||||
|
||||
.. autoclass:: D3D11Shader
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11ConstantBuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11Sampler
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11View
|
||||
:members:
|
||||
|
||||
Stream-out
|
||||
----------
|
||||
|
||||
.. autoclass:: D3D11StreamOut
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11StreamOutBind
|
||||
:members:
|
||||
|
||||
Rasterizer
|
||||
----------
|
||||
|
||||
.. autoclass:: D3D11Rasterizer
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11RasterizerState
|
||||
:members:
|
||||
|
||||
Output Merger
|
||||
-------------
|
||||
|
||||
.. autoclass:: D3D11OutputMerger
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11DepthStencilState
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D11BlendState
|
||||
:members:
|
||||
|
||||
Predication
|
||||
-----------
|
||||
|
||||
.. autoclass:: D3D11Predication
|
||||
:members:
|
||||
:imported-members:
|
||||
:exclude-members: D3D11State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D11
|
||||
|
||||
@@ -1,13 +1,85 @@
|
||||
D3D12 Pipeline State
|
||||
====================
|
||||
|
||||
.. contents::
|
||||
|
||||
.. currentmodule:: renderdoc
|
||||
|
||||
.. autoclass:: D3D12State
|
||||
:members:
|
||||
|
||||
.. automodule:: renderdoc
|
||||
:noindex:
|
||||
Root Signature and Bindings
|
||||
---------------------------
|
||||
|
||||
.. autoclass:: D3D12RootSignatureRange
|
||||
:members:
|
||||
:imported-members:
|
||||
:exclude-members: D3D12State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D12
|
||||
|
||||
.. autoclass:: D3D12ConstantBuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12Sampler
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12View
|
||||
:members:
|
||||
|
||||
Vertex Input
|
||||
------------
|
||||
|
||||
.. autoclass:: D3D12InputAssembly
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12Layout
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12VertexBuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12IndexBuffer
|
||||
:members:
|
||||
|
||||
Shader
|
||||
------
|
||||
|
||||
.. autoclass:: D3D12Shader
|
||||
:members:
|
||||
|
||||
Stream-out
|
||||
----------
|
||||
|
||||
.. autoclass:: D3D12StreamOut
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12StreamOutBind
|
||||
:members:
|
||||
|
||||
Rasterizer
|
||||
----------
|
||||
|
||||
.. autoclass:: D3D12Rasterizer
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12RasterizerState
|
||||
:members:
|
||||
|
||||
Output Merger
|
||||
-------------
|
||||
|
||||
.. autoclass:: D3D12OM
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12DepthStencilState
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12BlendState
|
||||
:members:
|
||||
|
||||
Resource States
|
||||
---------------
|
||||
|
||||
.. autoclass:: D3D12ResourceData
|
||||
:members:
|
||||
|
||||
.. autoclass:: D3D12ResourceState
|
||||
:members:
|
||||
|
||||
|
||||
@@ -1,13 +1,99 @@
|
||||
OpenGL Pipeline State
|
||||
=====================
|
||||
|
||||
.. contents::
|
||||
|
||||
.. currentmodule:: renderdoc
|
||||
|
||||
.. autoclass:: GLState
|
||||
:members:
|
||||
|
||||
.. automodule:: renderdoc
|
||||
:noindex:
|
||||
Vertex Input
|
||||
------------
|
||||
|
||||
.. autoclass:: GLVertexInput
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLVertexAttribute
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLVertexBuffer
|
||||
:members:
|
||||
|
||||
Shader
|
||||
------
|
||||
|
||||
.. autoclass:: GLShader
|
||||
:members:
|
||||
|
||||
Fixed Vertex Processing
|
||||
-----------------------
|
||||
|
||||
.. autoclass:: GLFixedVertexProcessing
|
||||
:members:
|
||||
|
||||
Shader Bindings
|
||||
---------------
|
||||
|
||||
.. autoclass:: GLTexture
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLSampler
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLBuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLImageLoadStore
|
||||
:members:
|
||||
|
||||
Transform Feedback
|
||||
------------------
|
||||
|
||||
.. autoclass:: GLFeedback
|
||||
:members:
|
||||
|
||||
Rasterizer
|
||||
----------
|
||||
|
||||
.. autoclass:: GLRasterizer
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLRasterizerState
|
||||
:members:
|
||||
|
||||
Depth/Stencil State
|
||||
-------------------
|
||||
|
||||
.. autoclass:: GLDepthState
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLStencilState
|
||||
:members:
|
||||
|
||||
Framebuffer
|
||||
-----------
|
||||
|
||||
.. autoclass:: GLFrameBuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLFBO
|
||||
:members:
|
||||
|
||||
.. autoclass:: GLAttachment
|
||||
:members:
|
||||
|
||||
Blending
|
||||
--------
|
||||
|
||||
.. autoclass:: GLBlendState
|
||||
:members:
|
||||
|
||||
Hints
|
||||
-----
|
||||
|
||||
.. autoclass:: GLHints
|
||||
:members:
|
||||
|
||||
.. autoclass:: QualityHint
|
||||
:members:
|
||||
:imported-members:
|
||||
:exclude-members: GLState, free_functions__, enum_constants__, name_match__include_only__startswith__GL
|
||||
|
||||
@@ -1,13 +1,136 @@
|
||||
Vulkan Pipeline State
|
||||
=====================
|
||||
|
||||
.. contents::
|
||||
|
||||
.. currentmodule:: renderdoc
|
||||
|
||||
.. autoclass:: VKState
|
||||
:members:
|
||||
|
||||
.. automodule:: renderdoc
|
||||
:noindex:
|
||||
Pipeline and Bindings
|
||||
---------------------
|
||||
|
||||
.. autoclass:: VKPipeline
|
||||
:members:
|
||||
:imported-members:
|
||||
:exclude-members: VKState, free_functions__, enum_constants__, name_match__include_only__startswith__VK
|
||||
|
||||
.. autoclass:: VKDescriptorSet
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKDescriptorBinding
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKBindingElement
|
||||
:members:
|
||||
|
||||
Vertex Input
|
||||
------------
|
||||
|
||||
.. autoclass:: VKInputAssembly
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKIndexBuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKVertexInput
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKVertexAttribute
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKVertexBinding
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKVertexBuffer
|
||||
:members:
|
||||
|
||||
Shader
|
||||
------
|
||||
|
||||
.. autoclass:: VKShader
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKSpecializationConstant
|
||||
:members:
|
||||
|
||||
Tessellation
|
||||
------------
|
||||
|
||||
.. autoclass:: VKTessellation
|
||||
:members:
|
||||
|
||||
Transform Feedback
|
||||
------------------
|
||||
|
||||
.. autoclass:: VKTransformFeedback
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKXFBBuffer
|
||||
:members:
|
||||
|
||||
Rasterizer
|
||||
----------
|
||||
|
||||
.. autoclass:: VKViewportScissor
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKViewState
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKRasterizer
|
||||
:members:
|
||||
|
||||
Multisampling
|
||||
-------------
|
||||
|
||||
.. autoclass:: VKMultiSample
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKSampleLocations
|
||||
:members:
|
||||
|
||||
Blending
|
||||
--------
|
||||
|
||||
.. autoclass:: VKColorBlendState
|
||||
:members:
|
||||
|
||||
Depth/Stencil State
|
||||
-------------------
|
||||
|
||||
.. autoclass:: VKDepthStencil
|
||||
:members:
|
||||
|
||||
Renderpass and Framebuffer
|
||||
--------------------------
|
||||
|
||||
.. autoclass:: VKCurrentPass
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKRenderPass
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKFramebuffer
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKAttachment
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKRenderArea
|
||||
:members:
|
||||
|
||||
Image States
|
||||
------------
|
||||
|
||||
.. autoclass:: VKImageData
|
||||
:members:
|
||||
|
||||
.. autoclass:: VKImageLayout
|
||||
:members:
|
||||
|
||||
Conditional Rendering
|
||||
---------------------
|
||||
|
||||
.. autoclass:: VKConditionalRendering
|
||||
:members:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user