gstgl.c.types

OpenGL context errors.

Compilation stage that caused an error

GLSL profiles

GLSL version list

Output anaglyph type to generate when downmixing to mono

The OpenGL texture target that an OpenGL texture can be bound to. The [gstgl.global.glValueSetTextureTargetFromMask], [gstgl.global.glValueGetTextureTargetMask], and [gstgl.global.glValueSetTextureTarget] functions can be used for handling texture targets with #GValue's when e.g. dealing with #GstCaps.

#GstGLAsyncDebug an opaque structure and should only be accessed through the provided API.

#GstGLBaseFilter handles the nitty gritty details of retrieving an OpenGL context. It also provided some wrappers around #GstBaseTransform's start(), stop() and set_caps() virtual methods that ensure an OpenGL context is available and current in the calling thread.

The base class for GStreamer GL Filter.

GstGLBaseMemory is a #GstMemory subclass providing the basis of support for the mapping of GL buffers.

Data is uploaded or downloaded from the GPU as is necessary.

Opaque #GstGLBaseMemoryAllocator struct

#GstGLBaseMixer handles the nitty gritty details of retrieving an OpenGL context. It provides some virtual methods to know when the OpenGL context is available and is not available within this element.

#GstGLBaseSrc handles the nitty gritty details of retrieving an OpenGL context. It also provided some wrappers around #GstBaseSrc's start() and stop() virtual methods that ensure an OpenGL context is available and current in the calling thread.

The base class for GStreamer GL Video sources.

GstGLBuffer is a #GstMemory subclass providing support for the mapping of GL buffers.

Data is uploaded or downloaded from the GPU as is necessary.

Opaque #GstGLBufferAllocator struct

The #GstGLBufferAllocatorClass only contains private data

a #GstGLBufferPool is an object that allocates buffers with #GstGLBaseMemory

A #GstGLBufferPool is created with [gstgl.glbuffer_pool.GLBufferPool.new_]

#GstGLBufferPool implements the VideoMeta buffer pool option [gstvideo.types.BUFFER_POOL_OPTION_VIDEO_META], the VideoAligment buffer pool option [gstvideo.types.BUFFER_POOL_OPTION_VIDEO_ALIGNMENT] as well as the OpenGL specific [gstgl.types.BUFFER_POOL_OPTION_GL_SYNC_META] buffer pool option.

The #GstGLBufferPoolClass structure contains only private data

#GstGLColorConvert is an object that converts between color spaces and/or formats using OpenGL Shaders.

A #GstGLColorConvert can be created with [gstgl.glcolor_convert.GLColorConvert.new_], the configuration negotiated with [gstgl.glcolor_convert.GLColorConvert.transformCaps] and the conversion performed with [gstgl.glcolor_convert.GLColorConvert.perform].

The glcolorconvertelement provides a GStreamer element that uses #GstGLColorConvert to convert between video formats and color spaces.

The #GstGLColorConvertClass struct only contains private data

#GstGLContext wraps an OpenGL context object in a uniform API. As a result of the limitation on OpenGL context, this object is not thread safe unless specified and must only be activated in a single thread.

Environment variables:

• GST_GL_API: select which OpenGL API to create and OpenGL context for.

Depending on the platform, the available values are 'opengl', 'opengl3' (core profile), and 'gles2'. See the the #GstGLAPI enumeration for more details.

• GST_GL_PLATFORM: select which OpenGL platform to create an OpenGL

context with. Depending on the platform and the dependencies available build-time, the available values are, 'glx', 'egl', 'cgl', 'wgl', and 'eagl'

• GST_GL_CONFIG: select the configuration used for creating the OpenGL

context and OpenGL surface. Written out as a GstStructure that has been serialized to string. e.g. GST_GL_CONFIG="gst-gl-context-config,red-size=8,green-size=8,blue-size=8,alpha-size=8,depth-size=16". Not all platforms will support the same level of functionality.

#GstGLDisplay represents a connection to the underlying windowing system. Elements are required to make use of #GstContext to share and propagate a #GstGLDisplay.

There are a number of environment variables that influence the choice of platform and window system specific functionality.

• GST_GL_WINDOW influences the window system to use. Common values are

'x11', 'wayland', 'surfaceless', 'win32' or 'cocoa'.

• GST_GL_PLATFORM influences the OpenGL platform to use. Common values are

'egl', 'glx', 'wgl' or 'cgl'.

• GST_GL_API influences the OpenGL API requested by the OpenGL platform.

Common values are 'opengl', 'opengl3' and 'gles2'.

Certain window systems require a special function to be called to

initialize threading support. As this GStreamer GL library does not preclude concurrent access to the windowing system, it is strongly advised that applications ensure that threading support has been initialized before any other toolkit/library functionality is accessed. Failure to do so could result in sudden application abortion during execution. The most notably example of such a function is X11's XInitThreads\().

#GstGLFilter helps to implement simple OpenGL filter elements taking a single input and producing a single output with a #GstGLFramebuffer

A #GstGLFramebuffer represents and holds an OpenGL framebuffer object with it's associated attachments.

A #GstGLFramebuffer can be created with [gstgl.glframebuffer.GLFramebuffer.new_] or [gstgl.glframebuffer.GLFramebuffer.newWithDefaultDepth] and bound with [gstgl.glframebuffer.GLFramebuffer.bind]. Other resources can be bound with [gstgl.glframebuffer.GLFramebuffer.attach]

Opaque #GstGLFramebufferClass struct

Structure containing function pointers to OpenGL functions.

Each field is named exactly the same as the OpenGL function without the gl prefix.

GstGLMemory is a #GstGLBaseMemory subclass providing support for the mapping of OpenGL textures.

#GstGLMemory is created or wrapped through [gstgl.glbase_memory.GLBaseMemory.alloc] with #GstGLVideoAllocationParams.

Data is uploaded or downloaded from the GPU as is necessary.

The #GstCaps that is used for #GstGLMemory based buffers should contain the [gstgl.types.CAPS_FEATURE_MEMORY_GL_MEMORY] as a #GstCapsFeatures and should contain a 'texture-target' field with one of the #GstGLTextureTarget values as a string, i.e. some combination of 'texture-target=(string){2D, rectangle, external-oes}'.

Opaque #GstGLMemoryAllocator struct

#GstGLMemoryPBO is created or wrapped through [gstgl.glbase_memory.GLBaseMemory.alloc] with #GstGLVideoAllocationParams.

Data is uploaded or downloaded from the GPU as is necessary.

Opaque #GstGLMemoryPBOAllocator struct

Only contains private data

#GstGLMixer helps implement an element that operates on RGBA textures.

Opaque #GstGLOverlayCompositor object

A #GstGLQuery represents and holds an OpenGL query object. Various types of queries can be run or counters retrieved.

GstGLRenderbuffer is a #GstGLBaseMemory subclass providing support for OpenGL renderbuffers.

#GstGLRenderbuffer is created or wrapped through [gstgl.glbase_memory.GLBaseMemory.alloc] with #GstGLRenderbufferAllocationParams.

Allocation parameters

Opaque #GstGLRenderbufferAllocator struct

The #GstGLRenderbufferAllocatorClass only contains private data

#GstGLSLStage holds and represents a single OpenGL shader stage.

Opaque #GstGLSLStageClass struct

#GstGLSyncMeta provides the ability to synchronize the OpenGL command stream with the CPU or with other OpenGL contexts.

#GstGLUpload is an object that uploads data from system memory into GL textures.

A #GstGLUpload can be created with [gstgl.glupload.GLUpload.new_]

The #GstGLUploadClass struct only contains private data

Convert stereoscopic/multiview video using fragment shaders.

Opaque #GstGLViewConvertClass struct

GstGLWindow represents a window that elements can render into. A window can either be a user visible window (onscreen) or hidden (offscreen).