Blame docs/libs/html/gst-plugins-base-libs-GstGLBaseMemory.html

Packit 971217
Packit 971217
<html>
Packit 971217
<head>
Packit 971217
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 971217
<title>GstGLBaseMemory: GStreamer Base Plugins 1.0 Library Reference Manual</title>
Packit 971217
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit 971217
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
Packit 971217
<link rel="up" href="gl.html" title="OpenGL Integration Library">
Packit 971217
<link rel="prev" href="GstGLBaseFilter.html" title="GstGLBaseFilter">
Packit 971217
<link rel="next" href="gst-plugins-base-libs-GstGLBuffer.html" title="GstGLBuffer">
Packit 971217
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit 971217
<link rel="stylesheet" href="style.css" type="text/css">
Packit 971217
</head>
Packit 971217
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 971217
Packit 971217
Packit 971217
Top  | 
Packit 971217
                  Description  | 
Packit 971217
                  Object Hierarchy
Packit 971217
Packit 971217
Home
Packit 971217
Up
Packit 971217
Prev
Packit 971217
Next
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

GstGLBaseMemory

Packit 971217

GstGLBaseMemory — memory subclass for GL buffers

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
(*GstGLAllocationParamsCopyFunc) ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
(*GstGLAllocationParamsFreeFunc) ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_gl_allocation_params_init ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstGLAllocationParams *
Packit 971217
Packit 971217
Packit 971217
gst_gl_allocation_params_copy ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_gl_allocation_params_free ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_gl_allocation_params_free_data ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_gl_allocation_params_copy_data ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_gl_base_memory_init_once ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_gl_base_memory_init ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_is_gl_base_memory ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstGLBaseMemory *
Packit 971217
Packit 971217
Packit 971217
(*GstGLBaseMemoryAllocatorAllocFunction) ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
(*GstGLBaseMemoryAllocatorCreateFunction) ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gpointer
Packit 971217
Packit 971217
Packit 971217
(*GstGLBaseMemoryAllocatorMapFunction) ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
(*GstGLBaseMemoryAllocatorUnmapFunction) ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstGLBaseMemory *
Packit 971217
Packit 971217
Packit 971217
(*GstGLBaseMemoryAllocatorCopyFunction) ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
(*GstGLBaseMemoryAllocatorDestroyFunction) ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstGLBaseMemory *
Packit 971217
Packit 971217
Packit 971217
gst_gl_base_memory_alloc ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_gl_base_memory_alloc_data ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_gl_base_memory_memcpy ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
 
Packit 971217
GstGLBaseMemoryAllocator
Packit 971217
Packit 971217
Packit 971217
 
Packit 971217
GstGLBaseMemoryAllocatorClass
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
GST_GL_BASE_MEMORY_ALLOCATOR_NAME
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
GST_MAP_GL
Packit 971217
Packit 971217
Packit 971217
enum
Packit 971217
GstGLBaseMemoryError
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
GST_GL_BASE_MEMORY_ERROR
Packit 971217
Packit 971217
Packit 971217
enum
Packit 971217
GstGLBaseMemoryTransfer
Packit 971217
Packit 971217
Packit 971217
struct
Packit 971217
GstGLAllocationParams
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_ALLOC
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_WRAP_SYSMEM
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_WRAP_GPU_HANDLE
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_USER
Packit 971217
Packit 971217
Packit 971217
 
Packit 971217
GstGLBaseMemory
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Object Hierarchy

Packit 971217
    GBoxed
Packit 971217
    ╰── GstGLAllocationParams
Packit 971217
    GObject
Packit 971217
    ╰── GInitiallyUnowned
Packit 971217
        ╰── GstObject
Packit 971217
            ╰── GstAllocator
Packit 971217
                ╰── GstGLBaseMemoryAllocator
Packit 971217
                    ├── GstGLBufferAllocator
Packit 971217
                    ├── GstGLMemoryAllocator
Packit 971217
                    ╰── GstGLRenderbufferAllocator
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Includes

Packit 971217
#include <gst/gl/gl.h>
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Description

Packit 971217

GstGLBaseMemory is a GstMemory subclass providing the basis of support

Packit 971217
for the mapping of GL buffers.

Packit 971217

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

Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217
Packit 971217

GstGLAllocationParamsCopyFunc ()

Packit 971217
void
Packit 971217
(*GstGLAllocationParamsCopyFunc) (GstGLAllocationParams *src,
Packit 971217
                                  GstGLAllocationParams *dest);
Packit 971217

Copies the parameters from src

Packit 971217
 into dest
Packit 971217
.  The subclass must compose copy
Packit 971217
functions from the superclass.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

src

Packit 971217

the source GstGLAllocationParams to copy from

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

dest

Packit 971217

the source GstGLAllocationParams to copy

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

GstGLAllocationParamsFreeFunc ()

Packit 971217
void
Packit 971217
(*GstGLAllocationParamsFreeFunc) (gpointer params);
Packit 971217

Free any dynamically allocated data. The subclass must call the superclass'

Packit 971217
free.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

params

Packit 971217

a GstGLAllocationParams

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_gl_allocation_params_init ()

Packit 971217
gboolean
Packit 971217
gst_gl_allocation_params_init (GstGLAllocationParams *params,
Packit 971217
                               gsize struct_size,
Packit 971217
                               guint alloc_flags,
Packit 971217
                               GstGLAllocationParamsCopyFunc copy,
Packit 971217
                               GstGLAllocationParamsFreeFunc free,
Packit 971217
                               GstGLContext *context,
Packit 971217
                               gsize alloc_size,
Packit 971217
                               GstAllocationParams *alloc_params,
Packit 971217
                               gpointer wrapped_data,
Packit 971217
                               gpointer gl_handle,
Packit 971217
                               gpointer user_data,
Packit 971217
                               GDestroyNotify notify);
Packit 971217

notify

Packit 971217
 will be called once for each allocated memory using these params
Packit 971217
Packit 971217
when freeing the memory.

Packit 971217

[skip]

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

params

Packit 971217

the GstGLAllocationParams to initialize

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

struct_size

Packit 971217

the struct size of the implementation

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

alloc_flags

Packit 971217

some alloc flags

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

copy

Packit 971217

a copy function

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

free

Packit 971217

a free function

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

context

Packit 971217

a GstGLContext.

Packit 971217
[transfer none]
Packit 971217
Packit 971217
Packit 971217

alloc_size

Packit 971217

the number of bytes to allocate.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

alloc_params

Packit 971217

a GstAllocationParams to apply.

Packit 971217
[transfer none][allow-none]
Packit 971217
Packit 971217
Packit 971217

wrapped_data

Packit 971217

a sysmem data pointer to initialize the allocation with.

Packit 971217
[transfer none][allow-none]
Packit 971217
Packit 971217
Packit 971217

gl_handle

Packit 971217

a GL handle to initialize the allocation with.

Packit 971217
[transfer none]
Packit 971217
Packit 971217
Packit 971217

user_data

Packit 971217

user data to call notify

Packit 971217
with. 

Packit 971217
[transfer none][allow-none]
Packit 971217
Packit 971217
Packit 971217

notify

Packit 971217

a GDestroyNotify.

Packit 971217
[allow-none]
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

whether the paramaters could be initialized

Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_gl_allocation_params_copy ()

Packit 971217
GstGLAllocationParams *
Packit 971217
gst_gl_allocation_params_copy (GstGLAllocationParams *src);
Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

src

Packit 971217

the GstGLAllocationParams to initialize

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

a copy of the GstGLAllocationParams specified by

Packit 971217
src
Packit 971217
or NULL on failure. 

Packit 971217

[transfer full]

Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_gl_allocation_params_free ()

Packit 971217
void
Packit 971217
gst_gl_allocation_params_free (GstGLAllocationParams *params);
Packit 971217

Frees the GstGLAllocationParams and all associated data.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

params

Packit 971217

the GstGLAllocationParams to initialize

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_gl_allocation_params_free_data ()

Packit 971217
void
Packit 971217
gst_gl_allocation_params_free_data (GstGLAllocationParams *params);
Packit 971217

Frees the dynamically allocated data in params

Packit 971217
.  Direct subclasses
Packit 971217
should call this function in their own overriden free function.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

params

Packit 971217

the source GstGLAllocationParams

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_gl_allocation_params_copy_data ()

Packit 971217
void
Packit 971217
gst_gl_allocation_params_copy_data (GstGLAllocationParams *src,
Packit 971217
                                    GstGLAllocationParams *dest);
Packit 971217

Copies the dynamically allocated data from src

Packit 971217
 to dest
Packit 971217
.  Direct subclasses
Packit 971217
should call this function in their own overriden copy function.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

src

Packit 971217

the source GstGLAllocationParams

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

dest

Packit 971217

the destination GstGLAllocationParams

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_gl_base_memory_init_once ()

Packit 971217
void
Packit 971217
gst_gl_base_memory_init_once (void);
Packit 971217

Initializes the GL Base Memory allocator. It is safe to call this function

Packit 971217
multiple times.  This must be called before any other GstGLBaseMemory operation.

Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_gl_base_memory_init ()

Packit 971217
void
Packit 971217
gst_gl_base_memory_init (GstGLBaseMemory *mem,
Packit 971217
                         GstAllocator *allocator,
Packit 971217
                         GstMemory *parent,
Packit 971217
                         GstGLContext *context,
Packit 971217
                         GstAllocationParams *params,
Packit 971217
                         gsize size,
Packit 971217
                         gpointer user_data,
Packit 971217
                         GDestroyNotify notify);
Packit 971217

Initializes mem

Packit 971217
 with the required parameters

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

mem

Packit 971217

the GstGLBaseMemory to initialize

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

allocator

Packit 971217

the GstAllocator to initialize with

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

parent

Packit 971217

the parent GstMemory to initialize with.

Packit 971217
[allow-none]
Packit 971217
Packit 971217
Packit 971217

context

Packit 971217

the GstGLContext to initialize with

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

params

Packit 971217

the GstAllocationParams

Packit 971217
to initialize with. 

Packit 971217
[allow-none]
Packit 971217
Packit 971217
Packit 971217

size

Packit 971217

the number of bytes to be allocated

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

user_data

Packit 971217

user data to call notify

Packit 971217
with. 

Packit 971217
[allow-none]
Packit 971217
Packit 971217
Packit 971217

notify

Packit 971217

a GDestroyNotify.

Packit 971217
[allow-none]
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_is_gl_base_memory ()

Packit 971217
gboolean
Packit 971217
gst_is_gl_base_memory (GstMemory *mem);
Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

mem

Packit 971217

a GstMemory

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

whether the memory at mem

Packit 971217
is a GstGLBaseMemory

Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorAllocFunction ()

Packit 971217
GstGLBaseMemory *
Packit 971217
(*GstGLBaseMemoryAllocatorAllocFunction)
Packit 971217
                               (GstGLBaseMemoryAllocator *allocator,
Packit 971217
                                GstGLAllocationParams *params);
Packit 971217

Note: not called with a GL context current

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

allocator

Packit 971217

a GstGLBaseMemoryAllocator

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

params

Packit 971217

the GstGLAllocationParams to allocate the memory with

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

a newly allocated GstGLBaseMemory from allocator

Packit 971217
and params
Packit 971217

Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorCreateFunction ()

Packit 971217
gboolean
Packit 971217
(*GstGLBaseMemoryAllocatorCreateFunction)
Packit 971217
                               (GstGLBaseMemory *mem,
Packit 971217
                                GError **error);
Packit 971217

As this virtual method is called with an OpenGL context current, use this

Packit 971217
function to allocate and OpenGL resources needed for your application

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

mem

Packit 971217

a GstGLBaseMemory

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

error

Packit 971217

a GError to use on failure

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

whether the creation succeeded

Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorMapFunction ()

Packit 971217
gpointer
Packit 971217
(*GstGLBaseMemoryAllocatorMapFunction)
Packit 971217
                               (GstGLBaseMemory *mem,
Packit 971217
                                GstMapInfo *info,
Packit 971217
                                gsize maxsize);
Packit 971217

Also see gst_memory_map();

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

mem

Packit 971217

a GstGLBaseMemory

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

info

Packit 971217

a GstMapInfo to map with

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

maxsize

Packit 971217

the size to map

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

the mapped pointer

Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorUnmapFunction ()

Packit 971217
void
Packit 971217
(*GstGLBaseMemoryAllocatorUnmapFunction)
Packit 971217
                               (GstGLBaseMemory *mem,
Packit 971217
                                GstMapInfo *info);
Packit 971217

Also see gst_memory_unmap();

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

mem

Packit 971217

a GstGLBaseMemory

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

info

Packit 971217

a GstMapInfo to map with

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorCopyFunction ()

Packit 971217
GstGLBaseMemory *
Packit 971217
(*GstGLBaseMemoryAllocatorCopyFunction)
Packit 971217
                               (GstGLBaseMemory *mem,
Packit 971217
                                gssize offset,
Packit 971217
                                gssize size);
Packit 971217

Also see gst_memory_copy();

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

mem

Packit 971217

a GstGLBaseMemory

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

offset

Packit 971217

the offset to copy from

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

size

Packit 971217

the number of bytes to copy

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

the newly copied GstGLMemory or NULL

Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorDestroyFunction ()

Packit 971217
void
Packit 971217
(*GstGLBaseMemoryAllocatorDestroyFunction)
Packit 971217
                               (GstGLBaseMemory *mem);
Packit 971217

Destroy any resources allocated throughout the lifetime of mem

Packit 971217

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

mem

Packit 971217

a GstGLBaseMemory

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_gl_base_memory_alloc ()

Packit 971217
GstGLBaseMemory *
Packit 971217
gst_gl_base_memory_alloc (GstGLBaseMemoryAllocator *allocator,
Packit 971217
                          GstGLAllocationParams *params);
Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

allocator

Packit 971217

a GstGLBaseMemoryAllocator

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

params

Packit 971217

the GstGLAllocationParams to allocate the memory with

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

a new GstGLBaseMemory from allocator

Packit 971217
with the requested params
Packit 971217
.

Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_gl_base_memory_alloc_data ()

Packit 971217
gboolean
Packit 971217
gst_gl_base_memory_alloc_data (GstGLBaseMemory *gl_mem);
Packit 971217

Note: only intended for subclass usage to allocate the sytem memory buffer

Packit 971217
on demand.  If there is already a non-NULL data pointer in gl_mem->data
Packit 971217
,
Packit 971217
then this function imply returns TRUE.

Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

gl_mem

Packit 971217

a GstGLBaseMemory

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

whether the system memory could be allocated

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_gl_base_memory_memcpy ()

Packit 971217
gboolean
Packit 971217
gst_gl_base_memory_memcpy (GstGLBaseMemory *src,
Packit 971217
                           GstGLBaseMemory *dest,
Packit 971217
                           gssize offset,
Packit 971217
                           gssize size);
Packit 971217
Packit 971217

Parameters

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

src

Packit 971217

the source GstGLBaseMemory

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

dest

Packit 971217

the destination GstGLBaseMemory

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

offset

Packit 971217

the offset to start at

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

size

Packit 971217

the number of bytes to copy

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Returns

Packit 971217

whether the copy suceeded.

Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217

GstGLBaseMemoryAllocator

Packit 971217
typedef struct _GstGLBaseMemoryAllocator GstGLBaseMemoryAllocator;
Packit 971217

Opaque GstGLBaseMemoryAllocator struct

Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorClass

Packit 971217
typedef struct {
Packit 971217
  GstAllocatorClass parent_class;
Packit 971217
Packit 971217
  GstGLBaseMemoryAllocatorAllocFunction         alloc;
Packit 971217
Packit 971217
  GstGLBaseMemoryAllocatorCreateFunction        create;
Packit 971217
  GstGLBaseMemoryAllocatorMapFunction           map;
Packit 971217
  GstGLBaseMemoryAllocatorUnmapFunction         unmap;
Packit 971217
  GstGLBaseMemoryAllocatorCopyFunction          copy;
Packit 971217
  GstGLBaseMemoryAllocatorDestroyFunction       destroy;
Packit 971217
} GstGLBaseMemoryAllocatorClass;
Packit 971217
Packit 971217
Packit 971217

Members

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorAllocFunction alloc;

Packit 971217

a GstGLBaseMemoryAllocatorAllocFunction

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorCreateFunction create;

Packit 971217

a GstGLBaseMemoryAllocatorCreateFunction

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorMapFunction map;

Packit 971217

a GstGLBaseMemoryAllocatorMapFunction

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorUnmapFunction unmap;

Packit 971217

a GstGLBaseMemoryAllocatorUnmapFunction

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorCopyFunction copy;

Packit 971217

a GstGLBaseMemoryAllocatorCopyFunction

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstGLBaseMemoryAllocatorDestroyFunction destroy;

Packit 971217

a GstGLBaseMemoryAllocatorDestroyFunction

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GST_GL_BASE_MEMORY_ALLOCATOR_NAME

Packit 971217
#define GST_GL_BASE_MEMORY_ALLOCATOR_NAME   "GLBaseMemory"
Packit 971217
Packit 971217

The name of the GL buffer allocator

Packit 971217

Since: 1.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GST_MAP_GL

Packit 971217
#define GST_MAP_GL (GST_MAP_FLAG_LAST << 1)
Packit 971217
Packit 971217

Flag indicating that we should map the GL object instead of to system memory.

Packit 971217

Combining GST_MAP_GL with GST_MAP_WRITE has the same semantics as though

Packit 971217
you are writing to OpenGL. Conversely, combining GST_MAP_GL with
Packit 971217
GST_MAP_READ has the same semantics as though you are reading from OpenGL.

Packit 971217
Packit 971217

Packit 971217
Packit 971217

enum GstGLBaseMemoryError

Packit 971217
Packit 971217

Members

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

GST_GL_BASE_MEMORY_ERROR_FAILED

Packit 971217
Packit 971217

generic faliure

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_GL_BASE_MEMORY_ERROR_OLD_LIBS

Packit 971217
Packit 971217

the implementation is too old and doesn't

Packit 971217
                                    implement enough features

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_GL_BASE_MEMORY_ERROR_RESOURCE_UNAVAILABLE

Packit 971217
Packit 971217

a resource could not be found

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

GST_GL_BASE_MEMORY_ERROR

Packit 971217
#define GST_GL_BASE_MEMORY_ERROR (gst_gl_base_memory_error_quark ())
Packit 971217
Packit 971217

Error domain for GStreamer's GL memory module. Errors in this domain will be

Packit 971217
from the GstGLBaseMemoryError enumeration

Packit 971217
Packit 971217

Packit 971217
Packit 971217

enum GstGLBaseMemoryTransfer

Packit 971217
Packit 971217

Members

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

GST_GL_BASE_MEMORY_TRANSFER_NEED_DOWNLOAD

Packit 971217
Packit 971217

the texture needs downloading

Packit 971217
                                            to the data pointer

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_GL_BASE_MEMORY_TRANSFER_NEED_UPLOAD

Packit 971217
Packit 971217

the data pointer needs uploading

Packit 971217
                                            to the texture

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

struct GstGLAllocationParams

Packit 971217
struct GstGLAllocationParams {
Packit 971217
  gsize                             struct_size;
Packit 971217
  GstGLAllocationParamsCopyFunc     copy;
Packit 971217
  GstGLAllocationParamsFreeFunc     free;
Packit 971217
Packit 971217
  guint                             alloc_flags;
Packit 971217
  gsize                             alloc_size;
Packit 971217
  GstAllocationParams              *alloc_params;
Packit 971217
  GstGLContext                     *context;
Packit 971217
  GDestroyNotify                    notify;
Packit 971217
  gpointer                          user_data;
Packit 971217
Packit 971217
  /* GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_WRAP_SYSMEM only */
Packit 971217
  gpointer                          wrapped_data;
Packit 971217
  /* GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_WRAP_GPU_HANDLE only */
Packit 971217
  gpointer                          gl_handle;
Packit 971217
};
Packit 971217
Packit 971217
Packit 971217

Members

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

gsize struct_size;

Packit 971217

the size of the struct (including and subclass data)

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstGLAllocationParamsCopyFunc copy;

Packit 971217

a GstGLAllocationParamsCopyFunc

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstGLAllocationParamsFreeFunc free;

Packit 971217

a GstGLAllocationParamsFreeFunc

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

guint alloc_flags;

Packit 971217

allocation flags

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

gsize alloc_size;

Packit 971217

the allocation size

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstAllocationParams *alloc_params;

Packit 971217

the GstAllocationParams

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstGLContext *context;

Packit 971217

a GstGLContext

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GDestroyNotify notify;

Packit 971217

a GDestroyNotify

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

gpointer user_data;

Packit 971217

argument to call notify

Packit 971217
with

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

gpointer wrapped_data;

Packit 971217

the wrapped data pointer

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

gpointer gl_handle;

Packit 971217

the wrapped OpenGL handle

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_ALLOC

Packit 971217
#define GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_ALLOC (1 << 0)
Packit 971217
Packit 971217

GL Allocation flag indicating that the implementation should allocate the

Packit 971217
necessary resources.

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_WRAP_SYSMEM

Packit 971217
#define GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_WRAP_SYSMEM (1 << 1)
Packit 971217
Packit 971217

GL Allocation flag for using the provided system memory data as storage.

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_WRAP_GPU_HANDLE

Packit 971217
#define GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_WRAP_GPU_HANDLE (1 << 2)
Packit 971217
Packit 971217

GL Allocation flag for using the provided GPU handle as storage.

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_USER

Packit 971217
#define GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_USER (1 << 16)
Packit 971217
Packit 971217

Values >= than GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_USER can be used for

Packit 971217
user-defined purposes.

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GstGLBaseMemory

Packit 971217
typedef struct {
Packit 971217
  GstMemory             mem;
Packit 971217
Packit 971217
  GstGLContext         *context;
Packit 971217
} GstGLBaseMemory;
Packit 971217
Packit 971217

Represents information about a GL memory object

Packit 971217
Packit 971217

Members

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

GstMemory mem;

Packit 971217

the parent object

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GstGLContext *context;

Packit 971217

the GstGLContext to use for GL operations

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

See Also

Packit 971217

GstMemory, GstAllocator

Packit 971217
Packit 971217
Packit 971217
Packit 971217

Generated by GTK-Doc V1.27
Packit 971217
</body>
Packit 971217
</html>