GLBufferPool

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 GST_BUFFER_POOL_OPTION_VIDEO_META, the VideoAligment buffer pool option GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT as well as the OpenGL specific GST_BUFFER_POOL_OPTION_GL_SYNC_META buffer pool option.

class GLBufferPool : BufferPool {

this(gstgl.glcontext.GLContext context);

gstgl.glallocation_params.GLAllocationParams getGlAllocationParams();

}

Constructors

this this(gstgl.glcontext.GLContext context)

Members

Functions

getGlAllocationParams gstgl.glallocation_params.GLAllocationParams getGlAllocationParams(): The returned #GstGLAllocationParams will by null before the first successful call to gst.buffer_pool.BufferPool.setConfig. Subsequent successful calls to gst.buffer_pool.BufferPool.setConfig will cause this function to return a new #GstGLAllocationParams which may or may not contain the same information.

Inherited Members

From BufferPool

configAddOption void configAddOption(gst.structure.Structure config, string option): Enables the option in config. This will instruct the bufferpool to enable the specified option on the buffers that it allocates.
configGetAllocator bool configGetAllocator(gst.structure.Structure config, gst.allocator.Allocator allocator, gst.allocation_params.AllocationParams params): Gets the allocator and params from config.
configGetOption string configGetOption(gst.structure.Structure config, uint index): Parses an available config and gets the option at index of the options API array.
configGetParams bool configGetParams(gst.structure.Structure config, gst.caps.Caps caps, uint size, uint minBuffers, uint maxBuffers): Gets the configuration values from config.
configHasOption bool configHasOption(gst.structure.Structure config, string option): Checks if config contains option.
configNOptions uint configNOptions(gst.structure.Structure config): Retrieves the number of values currently stored in the options array of the config structure.
configSetAllocator void configSetAllocator(gst.structure.Structure config, gst.allocator.Allocator allocator, gst.allocation_params.AllocationParams params): Sets the allocator and params on config.
configSetParams void configSetParams(gst.structure.Structure config, gst.caps.Caps caps, uint size, uint minBuffers, uint maxBuffers): Configures config with the given parameters.
configValidateParams bool configValidateParams(gst.structure.Structure config, gst.caps.Caps caps, uint size, uint minBuffers, uint maxBuffers): Validates that changes made to config are still valid in the context of the expected parameters. This function is a helper that can be used to validate changes made by a pool to a config when gst.buffer_pool.BufferPool.setConfig returns false. This expects that caps haven't changed and that min_buffers aren't lower then what we initially expected. This does not check if options or allocator parameters are still valid, won't check if size have changed, since changing the size is valid to adapt padding.
acquireBuffer gst.types.FlowReturn acquireBuffer(gst.buffer.Buffer buffer, gst.types.BufferPoolAcquireParams params): Acquires a buffer from pool. buffer should point to a memory location that can hold a pointer to the new buffer. When the pool is empty, this function will by default block until a buffer is released into the pool again or when the pool is set to flushing or deactivated.
getConfig gst.structure.Structure getConfig(): Gets a copy of the current configuration of the pool. This configuration can be modified and used for the gst.buffer_pool.BufferPool.setConfig call.
getOptions string[] getOptions(): Gets a null terminated array of string with supported bufferpool options for pool. An option would typically be enabled with gst.buffer_pool.BufferPool.configAddOption.
hasOption bool hasOption(string option): Checks if the bufferpool supports option.
isActive bool isActive(): Checks if pool is active. A pool can be activated with the gst.buffer_pool.BufferPool.setActive call.
releaseBuffer void releaseBuffer(gst.buffer.Buffer buffer): Releases buffer to pool. buffer should have previously been allocated from pool with gst.buffer_pool.BufferPool.acquireBuffer.
setActive bool setActive(bool active): Controls the active state of pool. When the pool is inactive, new calls to gst.buffer_pool.BufferPool.acquireBuffer will return with gst.types.FlowReturn.Flushing.
setConfig bool setConfig(gst.structure.Structure config): Sets the configuration of the pool. If the pool is already configured, and the configuration hasn't changed, this function will return true. If the pool is active, this method will return false and active configuration will remain. Buffers allocated from this pool must be returned or else this function will do nothing and return false.
setFlushing void setFlushing(bool flushing): Enables or disables the flushing state of a pool without freeing or allocating buffers.

gstgl glbuffer_pool classes

GLBufferPool