PySide6.QtGui.QRhiVertexInputBinding¶

class QRhiVertexInputBinding¶

Describes a vertex input binding.

Details

Specifies the stride (in bytes, must be a multiple of 4), the classification and optionally the instance step rate.

As an example, assume a vertex shader with the following inputs:

layout(location = 0) in vec4 position;
layout(location = 1) in vec2 texcoord;

Now let’s assume also that 3 component vertex positions (x, y, z) and 2 component texture coordinates (u, v) are provided in a non-interleaved format in a buffer (or separate buffers even). Defining two bindings could then be done like this:

QRhiVertexInputLayout inputLayout;
inputLayout.setBindings({
    { 3 * sizeof(float) },
    { 2 * sizeof(float) }
});

Only the stride is interesting here since instancing is not used. The binding number is given by the index of the QRhiVertexInputBinding element in the bindings vector of the QRhiVertexInputLayout .

Once a graphics pipeline with this vertex input layout is bound, the vertex inputs could be set up like the following for drawing a cube with 36 vertices, assuming we have a single buffer with first the positions and then the texture coordinates:

const QRhiCommandBuffer::VertexInput vbufBindings[] = {
    { cubeBuf, 0 },
    { cubeBuf, 36 * 3 * sizeof(float) }
};
cb->setVertexInput(0, 2, vbufBindings);

Note how the index defined by startBinding + i, where i is the index in the second argument of setVertexInput() , matches the index of the corresponding entry in the bindings vector of the QRhiVertexInputLayout .

Note

the stride must always be a multiple of 4.

Note

This is a RHI API with limited compatibility guarantees, see QRhi for details.

Synopsis¶

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

class Classification¶

Describes the input data classification.

Constant

Description

QRhiVertexInputBinding.Classification.PerVertex

Data is per-vertex

QRhiVertexInputBinding.Classification.PerInstance

Data is per-instance

Constant	Description
QRhiVertexInputBinding.Classification.PerVertex	Data is per-vertex
QRhiVertexInputBinding.Classification.PerInstance	Data is per-instance

__init__()¶

Constructs a default vertex input binding description.

__init__(stride[, cls=QRhiVertexInputBinding.Classification.PerVertex[, stepRate=1]])

Parameters:

stride – int
cls – Classification
stepRate – int

Constructs a vertex input binding description with the specified stride, classification cls, and instance step rate stepRate.

Note

stepRate other than 1 is only supported when CustomInstanceStepRate is reported to be supported.

classification()¶

Return type:: Classification

Returns the input data classification.

See also

setClassification()

instanceStepRate()¶

Return type:: int

Returns the instance step rate.

See also

setInstanceStepRate()

__ne__(b)¶

Parameters:: b – QRhiVertexInputBinding
Return type:: bool

__eq__(b)¶

Parameters:: b – QRhiVertexInputBinding
Return type:: bool

setClassification(c)¶

Parameters:: c – Classification

Sets the input data classification c. By default this is set to PerVertex .

See also

classification()

setInstanceStepRate(rate)¶

Parameters:: rate – int

Sets the instance step rate. By default this is set to 1.

See also

instanceStepRate()

setStride(s)¶

Parameters:: s – int

Sets the stride to s.

See also

stride()

stride()¶

Return type:: int

Returns the stride in bytes.

See also

setStride()