picogl.backend.opengl

gl Backend Interface.

This module provides an interface for a gl backend implementation, which offers functionalities for managing OpenGL state, drawing meshes, managing materials, handling client-side arrays, and interacting with textures.

Classes:

GLBackend: A class defining the interface for the gl backend with

various methods for rendering and managing rendering states.

Attributes

LegacyPipeline

Classes

GLBindingStrategy	Upload CPU mesh data to a reusable GPUMesh.
LegacyBinding	Upload MeshData to a client-state LegacyMesh.
ModernBinding	Upload MeshData to a VAO-backed ModernMesh.
GLLegacyPipeline	Fixed-function matrix, light, and material operations.
LegacyPipelineProtocol	Fixed-function and immediate-mode pipeline operations (legacy gl only).
AbstractGLBackend	ALL rendering must go through this interface.
GLPipeline	Deprecated alias for LegacyPipelineProtocol.

Module Contents

class picogl.backend.opengl.GLBindingStrategy

Bases: abc.ABC

Upload CPU mesh data to a reusable GPUMesh.

_last_gpu_mesh: picogl.backend.geometry.mesh.GPUMesh | None = None

abstract upload(mesh: picogl.renderer.meshdata.MeshData) → picogl.backend.geometry.mesh.GPUMesh

bind_mesh(mesh) → None

Deprecated: upload, bind, and remember mesh for the next draw.

draw(mesh, mode) → None

Deprecated: draw the last bound mesh, or upload on demand.

class picogl.backend.opengl.LegacyBinding

Bases: GLBindingStrategy

Upload MeshData to a client-state LegacyMesh.

upload(mesh: picogl.renderer.meshdata.MeshData) → picogl.backend.geometry.mesh.GPUMesh

class picogl.backend.opengl.ModernBinding

Bases: GLBindingStrategy

Upload MeshData to a VAO-backed ModernMesh.

upload(mesh: picogl.renderer.meshdata.MeshData) → picogl.backend.geometry.mesh.GPUMesh

upload_gpu_object(mesh: Any) → picogl.backend.geometry.mesh.GPUMesh

Wrap an object that already has vao / ebo / index_count.

bind_mesh(mesh) → None

Deprecated: upload, bind, and remember mesh for the next draw.

class picogl.backend.opengl.GLLegacyPipeline

Fixed-function matrix, light, and material operations.

static set_matrix_mode_model_view()

static set_matrix_mode_projection()

static load_identity()

static set_perspective(fovy, aspect, znear, zfar)

static set_projection(fovy, aspect, znear, zfar)

static translate(x, y, z)

static set_light(position, light=GLLight.LIGHT0)

static set_material(face, material)

static set_color_material(face=GLFace.FRONT_AND_BACK, mode=GLColorMaterialMode.AMBIENT_AND_DIFFUSE)

static set_color(rgba)

set_uniform_color(color, alpha)

static tex_coord2f(coord: picogl.backend.gl.state.texture.TexCoord2f)

static vertex_3f(v1: picogl.backend.gl.state.texture.Vertex3f)

picogl.backend.opengl.LegacyPipeline

class picogl.backend.opengl.LegacyPipelineProtocol

Bases: Protocol

Fixed-function and immediate-mode pipeline operations (legacy gl only).

set_matrix_mode_model_view()

set_matrix_mode_projection()

load_identity()

set_perspective(fovy, aspect, znear, zfar)

set_projection(fovy, aspect, znear, zfar)

translate(x, y, z)

set_light(position, light: Any = ...)

set_material(face, material)

set_color_material(face=..., mode=...)

set_color(rgba)

set_uniform_color(color, alpha)

tex_coord2f(coord: picogl.backend.gl.state.texture.TexCoord2f)

vertex_3f(v1: picogl.backend.gl.state.texture.Vertex3f)

class picogl.backend.opengl.AbstractGLBackend

Bases: abc.ABC

ALL rendering must go through this interface.

abstract set_blend(enabled: bool)

abstract set_depth_test(enabled: bool)

abstract set_depth_write(enabled: bool)

abstract set_cull_face(enabled: bool)

abstract set_line_width(width: float)

abstract set_polygon_mode(*args)

abstract set_lighting(enabled: bool)

abstract set_uniform_color(color: tuple, alpha: float)

abstract draw_elements(mode: int, indices)

class picogl.backend.opengl.GLPipeline

Bases: picogl.backend.legacy.core.pipeline.LegacyPipelineProtocol, Protocol

Deprecated alias for LegacyPipelineProtocol.

Do not use for new code. Modern rendering uses ShaderPipeline.