OpenGL Pipeline State

class renderdoc.GL_State

The full current OpenGL pipeline state.

AtomicBuffers

A list of GL_Buffer with the currently bound atomic buffers.

Images

A list of GL_ImageLoadStore with the currently bound load/store images.

Samplers

A list of GL_Sampler with the currently bound samplers.

ShaderStorageBuffers

A list of GL_Buffer with the currently bound shader storage buffers.

Textures

A list of GL_Texture with the currently bound textures.

UniformBuffers

A list of GL_Buffer with the currently bound uniform buffers.

m_CS

A GL_Shader describing the compute shader stage.

m_DepthState

A GL_DepthState describing depth processing.

m_FB

A GL_FrameBuffer describing the framebuffer.

m_FS

A GL_Shader describing the fragment shader stage.

m_Feedback

A GL_Feedback describing the transform feedback stage.

m_GS

A GL_Shader describing the geometry shader stage.

m_Hints

A GL_Hints describing the hint state.

m_Rasterizer

A GL_Rasterizer describing rasterization.

m_StencilState

A GL_StencilState describing stencil processing.

m_TCS

A GL_Shader describing the tessellation control shader stage.

m_TES

A GL_Shader describing the tessellation evaluation shader stage.

m_VS

A GL_Shader describing the vertex shader stage.

m_VtxIn

A GL_VertexInput describing the vertex input stage.

m_VtxProcess

A GL_FixedVertexProcessing describing the fixed-function vertex processing stage.

class renderdoc.GL_Attachment

Describes the state of a framebuffer attachment.

Layer

The slice of the texture that’s used in the attachment.

Mip

The mip of the texture that’s used in the attachment.

Obj

The ResourceId of the texture bound to this attachment.

Swizzle

Four TextureSwizzle elements indicating the swizzle applied to this texture.

class renderdoc.GL_Blend

Describes the blend configuration for a given OpenGL attachment.

Enabled

True if blending is enabled for this target.

Logic

The LogicOp to use for logic operations.

WriteMask

The mask for writes to the render target.

m_AlphaBlend

A GL_BlendEquation describing the blending for alpha values.

m_Blend

A GL_BlendEquation describing the blending for colour values.

class renderdoc.GL_BlendEquation

Describes the details of an OpenGL blend operation.

Destination

The BlendMultiplier for the destination blend value.

Operation

The BlendOp to use in the blend calculation.

Source

The BlendMultiplier for the source blend value.

class renderdoc.GL_BlendState

Describes the blend pipeline state.

BlendFactor

The constant blend factor to use in blend equations.

Blends

A list of GL_Blend describing the blend operations for each target.

class renderdoc.GL_Buffer

Describes the properties of a buffer.

Offset

The byte offset from the start of the buffer.

Resource

The ResourceId of the buffer object.

Size

The byte size of the buffer.

class renderdoc.GL_DepthState

Describes the depth state.

DepthBounds

True if depth bounds tests should be applied.

DepthEnable

True if depth testing should be performed.

DepthFunc

The CompareFunc to use for testing depth values.

DepthWrites

True if depth values should be written to the depth target.

FarBound

The far plane bounding value.

NearBound

The near plane bounding value.

class renderdoc.GL_FBO

Describes the contents of a framebuffer object.

Color

The list of GL_Attachment with the framebuffer color attachments.

Depth

The GL_Attachment with the framebuffer depth attachment.

DrawBuffers

The list of draw buffer indices into the Color attachment list.

Obj

The ResourceId of the framebuffer.

ReadBuffer

The read buffer index in the Color attachment list.

Stencil

The GL_Attachment with the framebuffer stencil attachment.

class renderdoc.GL_Feedback

Describes the current feedback state.

Active

True if the transform feedback object is currently active.

BufferBinding

A list of ResourceId with the buffer bindings.

Obj

The ResourceId of the transform feedback binding.

Offset

A list of int with the buffer byte offsets.

Paused

True if the transform feedback object is currently paused.

Size

A list of int with the buffer byte sizes.

class renderdoc.GL_FixedVertexProcessing

Describes the setup for fixed vertex processing operations.

clipNegativeOneToOne

True if the clip-space Z goes from -1 to 1.

False if the clip-space Z goes from 0 to 1.

clipOriginLowerLeft

True if the clipping origin should be in the lower left.

False if it’s in the upper left.

clipPlanes

A list of bool determining which user clipping planes are enabled.

defaultInnerLevel

A list of float giving the default inner level of tessellation.

defaultOuterLevel

A list of float giving the default outer level of tessellation.

discard

True if primitives should be discarded during rasterization.

class renderdoc.GL_FrameBuffer

Describes the current state of the framebuffer stage of the pipeline.

Dither

True if dithering should be used when writing to color buffers.

FramebufferSRGB

True if sRGB correction should be applied when writing to an sRGB-formatted texture.

m_Blending

A GL_BlendState with the details of the blending state.

m_DrawFBO

A GL_FBO with the information about a draw framebuffer.

m_ReadFBO

A GL_FBO with the information about a read framebuffer.

class renderdoc.GL_Hints

Describes the current state of GL hints and smoothing.

Derivatives

A QualityHint with the derivatives hint.

LineSmooth

A QualityHint with the line smoothing hint.

LineSmoothEnabled

True if line smoothing is enabled.

PolySmooth

A QualityHint with the polygon smoothing hint.

PolySmoothEnabled

True if polygon smoothing is enabled.

TexCompression

A QualityHint with the texture compression hint.

class renderdoc.GL_ImageLoadStore

Describes the properties of a load/store image.

Format

The ResourceFormat that the image is bound as.

Layer

The slice of the texture that’s used in the attachment.

Layered

True if multiple layers are bound together to the image. False if only one layer is bound.

Level

The mip of the texture that’s used in the attachment.

ResType

The TextureDim of the texture.

Resource

The ResourceId of the texture object.

readAllowed

True if loading from the image is allowed.

writeAllowed

True if storing to the image is allowed.

class renderdoc.GL_Rasterizer

Describes the rasterization state of the OpenGL pipeline.

Scissors

A list of GL_Scissor with the bound scissor regions.

Viewports

A list of GL_Viewport with the bound viewports.

m_State

A GL_RasterizerState with the details of the rasterization state.

class renderdoc.GL_RasterizerState

Describes the rasterizer state toggles.

DepthBias

The fixed depth bias value to apply to z-values.

DepthClamp

True if pixels outside of the near and far depth planes should be clamped and to 0.0 to 1.0 and not clipped.

FrontCCW

True if counter-clockwise polygons are front-facing. False if clockwise polygons are front-facing.

LineWidth

The fixed line width in pixels.

MinSampleShadingRate

The minimum sample shading rate.

MultisampleEnable

True if multisampling should be used during rendering.

OffsetClamp

The clamp value for calculated depth bias from DepthBias and SlopeScaledDepthBias

PointFadeThreshold

The threshold value at which points are clipped if they exceed this size.

PointOriginUpperLeft

True if the point sprite texture origin is upper-left. False if lower-left.

PointSize

The fixed point size in pixels.

ProgrammablePointSize

True if the point size can be programmably exported from a shader.

SampleAlphaToCoverage

True if alpha-to-coverage should be used when blending to an MSAA target.

SampleAlphaToOne

True if alpha-to-one should be used when blending to an MSAA target.

SampleCoverage

True if a temporary mask using SampleCoverageValue should be used to resolve the final output color.

SampleCoverageInvert

True if the temporary sample coverage mask should be inverted.

SampleCoverageValue

The sample coverage value used if SampleCoverage is True.

SampleMask

True if the generated samples should be bitwise AND masked with SampleMaskValue.

SampleMaskValue

The sample mask value that should be masked against the generated coverage.

SampleShading

True if rendering should happen at sample-rate frequency.

SlopeScaledDepthBias

The slope-scaled depth bias value to apply to z-values.

cullMode

The polygon culling mode.

fillMode

The polygon fill mode.

class renderdoc.GL_Sampler

Describes the sampler properties of a texture.

AddressR

The AddressMode in the R direction.

AddressS

The AddressMode in the S direction.

AddressT

The AddressMode in the T direction.

BorderColor

The RGBA border color.

Comparison

The CompareFunc for comparison samplers.

Filter

The TextureFilter describing the filtering mode.

MaxAniso

The maximum anisotropic filtering level to use.

MaxLOD

The maximum mip level that can be used.

MinLOD

The minimum mip level that can be used.

MipLODBias

A bias to apply to the calculated mip level before sampling.

Samp

The ResourceId of the sampler object, if a separate one is set.

SeamlessCube

True if seamless cubemap filtering is enabled for this texture.

UseBorder()

Check if the border color is used in this OpenGL sampler.

Returns:True if the border color is used, False otherwise.
Return type:bool
class renderdoc.GL_Scissor

Describes a single OpenGL scissor region.

Bottom

The Y co-ordinate of the bottom side of the scissor region.

Enabled

True if this scissor region is enabled.

Height

The height of the scissor region.

Left

The X co-ordinate of the left side of the scissor region.

Width

The width of the scissor region.

class renderdoc.GL_Shader

Describes an OpenGL shader stage.

BindpointMapping

A ShaderBindpointMapping to match ShaderDetails with the bindpoint mapping data.

Object

The ResourceId of the shader object itself.

PipelineActive

True if a program pipeline object is in use.

PipelineName

The name of the pipeline object.

ProgramName

The name of the program object.

ShaderDetails

A ShaderReflection describing the reflection data for this shader.

ShaderName

The name of the shader object.

Subroutines

A list of integers with the subroutine values.

customPipelineName

True if PipelineName was assigned by the application, otherwise it’s autogenerated based on the ID.

customProgramName

True if ProgramName was assigned by the application, otherwise it’s autogenerated based on the ID.

customShaderName

True if ShaderName was assigned by the application, otherwise it’s autogenerated based on the ID.

stage

A ShaderStage identifying which stage this shader is bound to.

class renderdoc.GL_StencilFace

Describes the details of an OpenGL stencil operation.

DepthFailOp

The StencilOp to apply if the depth-test fails.

FailOp

The StencilOp to apply if the stencil-test fails.

Func

The CompareFunc to use for testing stencil values.

PassOp

The StencilOp to apply if the stencil-test passes.

Ref

The current stencil reference value.

ValueMask

The mask for testing stencil values.

WriteMask

The mask for writing stencil values.

class renderdoc.GL_StencilState

Describes the stencil state.

StencilEnable

True if stencil operations should be performed.

m_BackFace

A GL_StencilFace describing what happens for back-facing polygons.

m_FrontFace

A GL_StencilFace describing what happens for front-facing polygons.

class renderdoc.GL_Texture

Describes the details of a texture.

DepthReadChannel

The channel to read from in a depth-stencil texture.

-1 for non depth-stencil textures.

0 if depth should be read.

1 if stencil should be read.

FirstSlice

Valid for texture arrays or 3D textures - the first slice available.

HighestMip

Valid for textures - the highest mip that is available.

ResType

The TextureDim of the texture.

Resource

The ResourceId of the underlying resource the view refers to.

Swizzle

Four TextureSwizzle elements indicating the swizzle applied to this texture.

class renderdoc.GL_VB

Describes a single OpenGL vertex buffer binding.

Buffer

The ResourceId of the buffer bound to this slot.

Divisor

The instance rate divisor.

If this is 0 then the vertex buffer is read at vertex rate.

If it’s 1 then one element is read for each instance, and for N greater than 1 then N instances read the same element before advancing.

Offset

The byte offset from the start of the buffer to the beginning of the vertex data.

Stride

The byte stride between the start of one set of vertex data and the next.

class renderdoc.GL_VertexAttribute

Describes the configuration for a single vertex attribute.

Note

If old-style vertex attrib pointer setup was used for the vertex attributes then it will be decomposed into 1:1 attributes and buffers.

BufferSlot

The vertex buffer input slot where the data is sourced from.

Enabled

True if this vertex attribute is enabled.

Format

The ResourceFormat of the vertex attribute.

GenericValue

A PixelValue containing the generic value of a vertex attribute.

RelativeOffset

The byte offset from the start of the vertex data in the vertex buffer from BufferSlot.

class renderdoc.GL_VertexInput

Describes the setup for fixed-function vertex input fetch.

attributes

A list of GL_VertexAttribute with the vertex attributes.

ibuffer

The ResourceId of the index buffer.

primitiveRestart

True if primitive restart is enabled for strip primitives.

provokingVertexLast

True if the provoking vertex is the last one in the primitive.

False if the provoking vertex is the first one.

restartIndex

The index value to use to indicate a strip restart.

vbuffers

A list of GL_VB with the vertex buffers.

class renderdoc.GL_Viewport

Describes a single OpenGL viewport.

Bottom

The Y co-ordinate of the bottom side of the viewport.

Height

The height of the viewport.

Left

The X co-ordinate of the left side of the viewport.

MaxDepth

The maximum depth of the viewport.

MinDepth

The minimum depth of the viewport.

Width

The width of the viewport.