GPU Types (gpu.types)

class gpu.types.Buffer(format, dimensions, data)

For Python access to GPU functions requiring a pointer.

Parameters:

format (str) – Format type to interpret the buffer. Possible values are FLOAT, INT, UINT, UBYTE, UINT_24_8 and 10_11_11_REV. UINT_24_8 is deprecated, use FLOAT instead.
dimensions (int) – Array describing the dimensions.
data (Buffer | Sequence[float] | Sequence[int]) – Optional data array.

return the buffer as a list

dimensions: Undocumented, consider contributing.

class gpu.types.GPUBatch(type, buf, elem=None)

Reusable container for drawable geometry.

Parameters:

type (str) – The primitive type of geometry to be drawn. Possible values are POINTS, LINES, TRIS, LINE_STRIP, LINE_LOOP, TRI_STRIP, TRI_FAN, LINES_ADJ, TRIS_ADJ and LINE_STRIP_ADJ.
buf (gpu.types.GPUVertBuf) – Vertex buffer containing all or some of the attributes required for drawing.
elem (gpu.types.GPUIndexBuf) – An optional index buffer.

draw(shader=None)

Run the drawing shader with the parameters assigned to the batch.

Parameters:: shader – Shader that performs the drawing operations. If None is passed, the last shader set to this batch will run.

draw_instanced(program, *, instance_start=0, instance_count=0)

Draw multiple instances of the drawing program with the parameters assigned to the batch. In the vertex shader, gl_InstanceID will contain the instance number being drawn.

Parameters:

program (gpu.types.GPUShader) – Program that performs the drawing operations.
instance_start (int) – Number of the first instance to draw.
instance_count (int) – Number of instances to draw. When not provided or set to 0 the number of instances will be determined by the number of rows in the first vertex buffer.

draw_range(program, *, elem_start=0, elem_count=0)

Run the drawing program with the parameters assigned to the batch. Only draw the elem_count elements of the index buffer starting at elem_start.

Parameters:

program (gpu.types.GPUShader) – Program that performs the drawing operations.
elem_start (int) – First index to draw. When not provided or set to 0 drawing will start from the first element of the index buffer.
elem_count (int) – Number of elements of the index buffer to draw. When not provided or set to 0 all elements from elem_start to the end of the index buffer will be drawn.

program_set(program)

Assign a shader to this batch that will be used for drawing when not overwritten later. Note: This method has to be called in the draw context that the batch will be drawn in. This function does not need to be called when you always set the shader when calling gpu.types.GPUBatch.draw().

Parameters:: program (gpu.types.GPUShader) – The program/shader the batch will use in future draw calls.

vertbuf_add(buf)

Add another vertex buffer to the Batch. It is not possible to add more vertices to the batch using this method. Instead it can be used to add more attributes to the existing vertices. A good use case would be when you have a separate vertex buffer for vertex positions and vertex normals. Current a batch can have at most GPU_BATCH_VBO_MAX_LEN vertex buffers.

Parameters:: buf (gpu.types.GPUVertBuf) – The vertex buffer that will be added to the batch.

class gpu.types.GPUFrameBuffer(depth_slot=None, color_slots=None)

This object gives access to framebuffer functionalities. When a ‘layer’ is specified in a argument, a single layer of a 3D or array texture is attached to the frame-buffer. For cube map textures, layer is translated into a cube map face.

Parameters:

depth_slot (gpu.types.GPUTexture | dict[] | None) – GPUTexture to attach or a dict containing keywords: ‘texture’, ‘layer’ and ‘mip’.
color_slots (gpu.types.GPUTexture | dict[str, int | gpu.types.GPUTexture] | Sequence[gpu.types.GPUTexture | dict[str, int | gpu.types.GPUTexture]] | None) – Tuple where each item can be a GPUTexture or a dict containing keywords: ‘texture’, ‘layer’ and ‘mip’.

bind(): Context manager to ensure balanced bind calls, even in the case of an error.

clear(color=None, depth=None, stencil=None)

Fill color, depth and stencil textures with specific value. Common values: color=(0.0, 0.0, 0.0, 1.0), depth=1.0, stencil=0.

Parameters:

color (Sequence[float]) – Sequence of 3 or 4 floats representing (r, g, b, a).
depth (float) – depth value.
stencil (int) – stencil value.

read_color(x, y, xsize, ysize, channels, slot, format, data=data)

Read a block of pixels from the frame buffer.

Parameters:

y (x,) – Lower left corner of a rectangular block of pixels.
ysize (xsize,) – Dimensions of the pixel rectangle.
channels (int) – Number of components to read.
slot (int) – The framebuffer slot to read data from.
format (str) – The format that describes the content of a single channel. Possible values are FLOAT, INT, UINT, UBYTE, UINT_24_8 and 10_11_11_REV. UINT_24_8 is deprecated, use FLOAT instead.
data (gpu.types.Buffer) – Optional Buffer object to fill with the pixels values.

Returns:

The Buffer with the read pixels.

Return type:

gpu.types.Buffer

read_depth(x, y, xsize, ysize, data=data)

Read a pixel depth block from the frame buffer.

Parameters:

y (x,) – Lower left corner of a rectangular block of pixels.
ysize (xsize,) – Dimensions of the pixel rectangle.
data (gpu.types.Buffer) – Optional Buffer object to fill with the pixels values.

Returns:

The Buffer with the read pixels.

Return type:

gpu.types.Buffer

viewport_get(): Returns position and dimension to current viewport.

viewport_set(x, y, xsize, ysize)

Set the viewport for this framebuffer object. Note: The viewport state is not saved upon framebuffer rebind.

Parameters:

y (x,) – lower left corner of the viewport_set rectangle, in pixels.
ysize (xsize,) – width and height of the viewport_set.

is_bound: Checks if this is the active framebuffer in the context.

class gpu.types.GPUIndexBuf(type, seq)

Contains an index buffer.

Parameters:

type (str) – The primitive type this index buffer is composed of. Possible values are [POINTS, LINES, TRIS, LINES_ADJ, TRIS_ADJ].
seq (Buffer | Sequence[int] | Sequence[Sequence[int]]) – Indices this index buffer will contain. Whether a 1D or 2D sequence is required depends on the type. Optionally the sequence can support the buffer protocol.

class gpu.types.GPUOffScreen(width, height, *, format='RGBA8')

This object gives access to off screen buffers.

Parameters:

width (int) – Horizontal dimension of the buffer.
height (int) – Vertical dimension of the buffer.
format (str) – Internal data format inside GPU memory for color attachment texture. Possible values are: RGBA8, RGBA16, RGBA16F, RGBA32F,

bind(): Context manager to ensure balanced bind calls, even in the case of an error.

draw_view3d(scene, view_layer, view3d, region, view_matrix, projection_matrix, do_color_management=False, draw_background=True)

Draw the 3d viewport in the offscreen object.

Parameters:

scene (bpy.types.Scene) – Scene to draw.
view_layer (bpy.types.ViewLayer) – View layer to draw.
view3d (bpy.types.SpaceView3D) – 3D View to get the drawing settings from.
region (bpy.types.Region) – Region of the 3D View (required as temporary draw target).
view_matrix (mathutils.Matrix) – View Matrix (e.g. camera.matrix_world.inverted()).
projection_matrix (mathutils.Matrix) – Projection Matrix (e.g. camera.calc_matrix_camera(...)).
do_color_management (bool) – Color manage the output.
draw_background (bool) – Draw background.

free(): Free the offscreen object. The framebuffer, texture and render objects will no longer be accessible.

unbind(restore=True)

Unbind the offscreen object.

Parameters:: restore (bool) – Restore the OpenGL state, can only be used when the state has been saved before.

height

Height of the texture.

Type:: int

texture_color

The color texture attached.

Type:: gpu.types.GPUTexture

width

Width of the texture.

Type:: int

class gpu.types.GPUShader

attr_from_name(name)

Get attribute location by name.

Parameters:: name (str) – The name of the attribute variable whose location is to be queried.
Returns:: The location of an attribute variable.
Return type:: int

attrs_info_get()

Information about the attributes used in the Shader.

Returns:: tuples containing information about the attributes in order (name, type)
Return type:: tuple[tuple[str, str | None], …]

bind(): Bind the shader object. Required to be able to change uniforms of this shader.

format_calc()

Build a new format based on the attributes of the shader.

Returns:: vertex attribute format for the shader
Return type:: gpu.types.GPUVertFormat

image(name, texture)

Specify the value of an image variable for the current GPUShader.

Parameters:

name (str) – Name of the image variable to which the texture is to be bound.
texture (gpu.types.GPUTexture) – Texture to attach.

uniform_block(name, ubo)

Specify the value of an uniform buffer object variable for the current GPUShader.

Parameters:

name (str) – name of the uniform variable whose UBO is to be specified.
ubo – Uniform Buffer to attach.

uniform_block_from_name(name)

Get uniform block location by name.

Parameters:: name (str) – Name of the uniform block variable whose location is to be queried.
Returns:: The location of the uniform block variable.
Return type:: int

uniform_bool(name, value)

Specify the value of a uniform variable for the current program object.

Parameters:

name (str) – Name of the uniform variable whose value is to be changed.
value (bool | Sequence[bool]) – Value that will be used to update the specified uniform variable.

uniform_float(name, value)

Specify the value of a uniform variable for the current program object.

Parameters:

name (str) – Name of the uniform variable whose value is to be changed.
value (float | Sequence[float]) – Value that will be used to update the specified uniform variable.

uniform_from_name(name)

Get uniform location by name.

Parameters:: name (str) – Name of the uniform variable whose location is to be queried.
Returns:: Location of the uniform variable.
Return type:: int

uniform_int(name, seq)

Specify the value of a uniform variable for the current program object.

Parameters:

name (str) – name of the uniform variable whose value is to be changed.
seq (Sequence[int]) – Value that will be used to update the specified uniform variable.

uniform_sampler(name, texture)

Specify the value of a texture uniform variable for the current GPUShader.

Parameters:

name (str) – name of the uniform variable whose texture is to be specified.
texture (gpu.types.GPUTexture) – Texture to attach.

uniform_vector_float(location, buffer, length, count)

Set the buffer to fill the uniform.

Parameters:

location (int) – Location of the uniform variable to be modified.
buffer (Sequence[float]) – The data that should be set. Can support the buffer protocol.
length (int) –
Size of the uniform data type:
- 1: float
- 2: vec2 or float[2]
- 3: vec3 or float[3]
- 4: vec4 or float[4]
- 9: mat3
- 16: mat4
count (int) – Specifies the number of elements, vector or matrices that are to be modified.

uniform_vector_int(location, buffer, length, count): See GPUShader.uniform_vector_float(…) description.

name

The name of the shader object for debugging purposes (read-only).

Type:: str

program

The name of the program object for use by the OpenGL API (read-only). This is deprecated and will always return -1.

Type:: int

class gpu.types.GPUShaderCreateInfo

Stores and describes types and variables that are used in shader sources.

compute_source(source)

compute shader source code written in GLSL.

Example:

"""void main() {
   int2 index = int2(gl_GlobalInvocationID.xy);
   vec4 color = vec4(0.0, 0.0, 0.0, 1.0);
   imageStore(img_output, index, color);
}"""

Parameters:: source (str) – The compute shader source code.