Merge pull request #97346 from DevPoodle/vertex-attribute-docs

Add descriptions to RDVertexAttribute's properties
This commit is contained in:
Thaddeus Crews 2024-11-27 10:47:09 -06:00
commit 06f4bcdefb
No known key found for this signature in database
GPG Key ID: 62181B86FE9E5D84

View File

@ -10,14 +10,19 @@
</tutorials>
<members>
<member name="format" type="int" setter="set_format" getter="get_format" enum="RenderingDevice.DataFormat" default="218">
The way that this attribute's data is interpreted when sent to a shader.
</member>
<member name="frequency" type="int" setter="set_frequency" getter="get_frequency" enum="RenderingDevice.VertexFrequency" default="0">
The rate at which this attribute is pulled from its vertex buffer.
</member>
<member name="location" type="int" setter="set_location" getter="get_location" default="0">
The location in the shader that this attribute is bound to.
</member>
<member name="offset" type="int" setter="set_offset" getter="get_offset" default="0">
The number of bytes between the start of the vertex buffer and the first instance of this attribute.
</member>
<member name="stride" type="int" setter="set_stride" getter="get_stride" default="0">
The number of bytes between the starts of consecutive instances of this attribute.
</member>
</members>
</class>