# GstGLFormat

Some useful utilities for converting between various formats and OpenGL formats.

## Functions

### gst_gl_format_from_video_info

    GstGLFormat
    gst_gl_format_from_video_info (GstGLContext * context,
                                   const GstVideoInfo * vinfo,
                                   guint plane)

Parameters:

`context` –

a GstGLContext

`vinfo` –

a GstVideoInfo

`plane` –

the plane number in vinfo

Returns –

the GstGLFormat necessary for holding the data in plane of vinfo

### GstGL.prototype.gl_format_from_video_info

    function GstGL.prototype.gl_format_from_video_info(context: GstGL.GLContext, vinfo: GstVideo.VideoInfo, plane: Number): {
        // javascript wrapper for 'gst_gl_format_from_video_info'
    }

Parameters:

`context` (GstGL.GLContext) –

a GstGL.GLContext

`vinfo` (GstVideo.VideoInfo) –

a GstVideo.VideoInfo

`plane` (Number) –

the plane number in vinfo

Returns (GstGL.GLFormat) –

the GstGL.GLFormat necessary for holding the data in plane of vinfo

### GstGL.gl_format_from_video_info

    def GstGL.gl_format_from_video_info (context, vinfo, plane):
        #python wrapper for 'gst_gl_format_from_video_info'

Parameters:

`context` (GstGL.GLContext) –

a GstGL.GLContext

`vinfo` (GstVideo.VideoInfo) –

a GstVideo.VideoInfo

`plane` (int) –

the plane number in vinfo

Returns (GstGL.GLFormat) –

the GstGL.GLFormat necessary for holding the data in plane of vinfo

### gst_gl_format_is_supported

    gboolean
    gst_gl_format_is_supported (GstGLContext * context,
                                GstGLFormat format)

Parameters:

`context` –

a GstGLContext

`format` –

the GstGLFormat to check is supported by context

Returns –

Whether format is supported by context based on the OpenGL API, version, or available OpenGL extension/s.

Since : 1.16

### GstGL.prototype.gl_format_is_supported

    function GstGL.prototype.gl_format_is_supported(context: GstGL.GLContext, format: GstGL.GLFormat): {
        // javascript wrapper for 'gst_gl_format_is_supported'
    }

Parameters:

`context` (GstGL.GLContext) –

a GstGL.GLContext

`format` (GstGL.GLFormat) –

the GstGL.GLFormat to check is supported by context

Returns (Number) –

Whether format is supported by context based on the OpenGL API, version, or available OpenGL extension/s.

Since : 1.16

### GstGL.gl_format_is_supported

    def GstGL.gl_format_is_supported (context, format):
        #python wrapper for 'gst_gl_format_is_supported'

Parameters:

`context` (GstGL.GLContext) –

a GstGL.GLContext

`format` (GstGL.GLFormat) –

the GstGL.GLFormat to check is supported by context

Returns (bool) –

Whether format is supported by context based on the OpenGL API, version, or available OpenGL extension/s.

Since : 1.16

### gst_gl_format_type_from_sized_gl_format

    gst_gl_format_type_from_sized_gl_format (GstGLFormat format,
                                             GstGLFormat * unsized_format,
                                             guint * gl_type)

Get the unsized format and type from format for usage in glReadPixels, glTex{Sub}Image*, glTexImage* and similar functions.

Parameters:

`format` –

the sized internal GstGLFormat

`unsized_format` ( [out]) –

location for the resulting unsized GstGLFormat

`gl_type` ( [out]) –

location for the resulting GL type

Since : 1.16

### GstGL.prototype.gl_format_type_from_sized_gl_format

    function GstGL.prototype.gl_format_type_from_sized_gl_format(format: GstGL.GLFormat): {
        // javascript wrapper for 'gst_gl_format_type_from_sized_gl_format'
    }

Get the unsized format and type from format for usage in glReadPixels, glTex{Sub}Image*, glTexImage* and similar functions.

Parameters:

`format` (GstGL.GLFormat) –

the sized internal GstGL.GLFormat

Since : 1.16

### GstGL.gl_format_type_from_sized_gl_format

    def GstGL.gl_format_type_from_sized_gl_format (format):
        #python wrapper for 'gst_gl_format_type_from_sized_gl_format'

Get the unsized format and type from format for usage in glReadPixels, glTex{Sub}Image*, glTexImage* and similar functions.

Parameters:

`format` (GstGL.GLFormat) –

the sized internal GstGL.GLFormat

Since : 1.16

### gst_gl_format_type_n_bytes

    guint
    gst_gl_format_type_n_bytes (guint format,
                                guint type)

Parameters:

`format` –

the OpenGL format, `GL_RGBA`, `GL_LUMINANCE`, etc

`type` –

the OpenGL type, `GL_UNSIGNED_BYTE`, `GL_FLOAT`, etc

Returns –

the number of bytes the specified format, type combination takes per pixel

### GstGL.prototype.gl_format_type_n_bytes

    function GstGL.prototype.gl_format_type_n_bytes(format: Number, type: Number): {
        // javascript wrapper for 'gst_gl_format_type_n_bytes'
    }

Parameters:

`format` (Number) –

the OpenGL format, `GL_RGBA`, `GL_LUMINANCE`, etc

`type` (Number) –

the OpenGL type, `GL_UNSIGNED_BYTE`, `GL_FLOAT`, etc

Returns (Number) –

the number of bytes the specified format, type combination takes per pixel

### GstGL.gl_format_type_n_bytes

    def GstGL.gl_format_type_n_bytes (format, type):
        #python wrapper for 'gst_gl_format_type_n_bytes'

Parameters:

`format` (int) –

the OpenGL format, `GL_RGBA`, `GL_LUMINANCE`, etc

`type` (int) –

the OpenGL type, `GL_UNSIGNED_BYTE`, `GL_FLOAT`, etc

Returns (int) –

the number of bytes the specified format, type combination takes per pixel

### gst_gl_sized_gl_format_from_gl_format_type

    guint
    gst_gl_sized_gl_format_from_gl_format_type (GstGLContext * context,
                                                guint format,
                                                guint type)

Parameters:

`context` –

a GstGLContext

`format` –

an OpenGL format, `GL_RGBA`, `GL_LUMINANCE`, etc

`type` –

an OpenGL type, `GL_UNSIGNED_BYTE`, `GL_FLOAT`, etc

Returns –

the sized internal format specified by format and type that can be used in context

### GstGL.prototype.gl_sized_gl_format_from_gl_format_type

    function GstGL.prototype.gl_sized_gl_format_from_gl_format_type(context: GstGL.GLContext, format: Number, type: Number): {
        // javascript wrapper for 'gst_gl_sized_gl_format_from_gl_format_type'
    }

Parameters:

`context` (GstGL.GLContext) –

a GstGL.GLContext

`format` (Number) –

an OpenGL format, `GL_RGBA`, `GL_LUMINANCE`, etc

`type` (Number) –

an OpenGL type, `GL_UNSIGNED_BYTE`, `GL_FLOAT`, etc

Returns (Number) –

the sized internal format specified by format and type that can be used in context

### GstGL.gl_sized_gl_format_from_gl_format_type

    def GstGL.gl_sized_gl_format_from_gl_format_type (context, format, type):
        #python wrapper for 'gst_gl_sized_gl_format_from_gl_format_type'

Parameters:

`context` (GstGL.GLContext) –

a GstGL.GLContext

`format` (int) –

an OpenGL format, `GL_RGBA`, `GL_LUMINANCE`, etc

`type` (int) –

an OpenGL type, `GL_UNSIGNED_BYTE`, `GL_FLOAT`, etc

Returns (int) –

the sized internal format specified by format and type that can be used in context

### gst_gl_texture_target_from_gl

    GstGLTextureTarget
    gst_gl_texture_target_from_gl (guint target)

Parameters:

`target` –

an OpenGL texture binding target

Returns –

the GstGLTextureTarget that's equiavalant to target or GST_GL_TEXTURE_TARGET_NONE

### GstGL.prototype.gl_texture_target_from_gl

    function GstGL.prototype.gl_texture_target_from_gl(target: Number): {
        // javascript wrapper for 'gst_gl_texture_target_from_gl'
    }

Parameters:

`target` (Number) –

an OpenGL texture binding target

Returns (GstGL.GLTextureTarget) –

the GstGL.GLTextureTarget that's equiavalant to target or GstGL.GLTextureTarget.NONE

### GstGL.gl_texture_target_from_gl

    def GstGL.gl_texture_target_from_gl (target):
        #python wrapper for 'gst_gl_texture_target_from_gl'

Parameters:

`target` (int) –

an OpenGL texture binding target

Returns (GstGL.GLTextureTarget) –

the GstGL.GLTextureTarget that's equiavalant to target or GstGL.GLTextureTarget.NONE

### gst_gl_texture_target_from_string

    GstGLTextureTarget
    gst_gl_texture_target_from_string (const gchar * str)

Parameters:

`str` –

a string equivalent to one of the GST_GL_TEXTURE_TARGET_*_STR values

Returns –

the GstGLTextureTarget represented by str or GST_GL_TEXTURE_TARGET_NONE

### GstGL.prototype.gl_texture_target_from_string

    function GstGL.prototype.gl_texture_target_from_string(str: String): {
        // javascript wrapper for 'gst_gl_texture_target_from_string'
    }

Parameters:

`str` (String) –

a string equivalent to one of the GST_GL_TEXTURE_TARGET_*_STR values

Returns (GstGL.GLTextureTarget) –

the GstGL.GLTextureTarget represented by str or GstGL.GLTextureTarget.NONE

### GstGL.gl_texture_target_from_string

    def GstGL.gl_texture_target_from_string (str):
        #python wrapper for 'gst_gl_texture_target_from_string'

Parameters:

`str` (str) –

a string equivalent to one of the GST_GL_TEXTURE_TARGET_*_STR values

Returns (GstGL.GLTextureTarget) –

the GstGL.GLTextureTarget represented by str or GstGL.GLTextureTarget.NONE

### gst_gl_texture_target_to_buffer_pool_option

    const gchar *
    gst_gl_texture_target_to_buffer_pool_option (GstGLTextureTarget target)

Parameters:

`target` –

a GstGLTextureTarget

Returns ( [nullable]) –

a string representing the GstBufferPoolOption specified by target

### GstGL.prototype.gl_texture_target_to_buffer_pool_option

    function GstGL.prototype.gl_texture_target_to_buffer_pool_option(target: GstGL.GLTextureTarget): {
        // javascript wrapper for 'gst_gl_texture_target_to_buffer_pool_option'
    }

Parameters:

`target` (GstGL.GLTextureTarget) –

a GstGL.GLTextureTarget

Returns (String) –

a string representing the GstBufferPoolOption specified by target

### GstGL.gl_texture_target_to_buffer_pool_option

    def GstGL.gl_texture_target_to_buffer_pool_option (target):
        #python wrapper for 'gst_gl_texture_target_to_buffer_pool_option'

Parameters:

`target` (GstGL.GLTextureTarget) –

a GstGL.GLTextureTarget

Returns (str) –

a string representing the GstBufferPoolOption specified by target

### gst_gl_texture_target_to_gl

    guint
    gst_gl_texture_target_to_gl (GstGLTextureTarget target)

Parameters:

`target` –

a GstGLTextureTarget

Returns –

the OpenGL value for binding the target with glBindTexture and similar functions or 0

### GstGL.prototype.gl_texture_target_to_gl

    function GstGL.prototype.gl_texture_target_to_gl(target: GstGL.GLTextureTarget): {
        // javascript wrapper for 'gst_gl_texture_target_to_gl'
    }

Parameters:

`target` (GstGL.GLTextureTarget) –

a GstGL.GLTextureTarget

Returns (Number) –

the OpenGL value for binding the target with glBindTexture and similar functions or 0

### GstGL.gl_texture_target_to_gl

    def GstGL.gl_texture_target_to_gl (target):
        #python wrapper for 'gst_gl_texture_target_to_gl'

Parameters:

`target` (GstGL.GLTextureTarget) –

a GstGL.GLTextureTarget

Returns (int) –

the OpenGL value for binding the target with glBindTexture and similar functions or 0

### gst_gl_texture_target_to_string

    const gchar *
    gst_gl_texture_target_to_string (GstGLTextureTarget target)

Parameters:

`target` –

a GstGLTextureTarget

Returns ( [nullable]) –

the stringified version of target or NULL

### GstGL.prototype.gl_texture_target_to_string

    function GstGL.prototype.gl_texture_target_to_string(target: GstGL.GLTextureTarget): {
        // javascript wrapper for 'gst_gl_texture_target_to_string'
    }

Parameters:

`target` (GstGL.GLTextureTarget) –

a GstGL.GLTextureTarget

Returns (String) –

the stringified version of target or null

### GstGL.gl_texture_target_to_string

    def GstGL.gl_texture_target_to_string (target):
        #python wrapper for 'gst_gl_texture_target_to_string'

Parameters:

`target` (GstGL.GLTextureTarget) –

a GstGL.GLTextureTarget

Returns (str) –

the stringified version of target or None

## Enumerations

### GstGLFormat

##### Members

`GST_GL_LUMINANCE` (6409) –

Single component replicated across R, G, and B textures components

`GST_GL_ALPHA` (6406) –

Single component stored in the A texture component

`GST_GL_LUMINANCE_ALPHA` (6410) –

Combination of GST_GL_LUMINANCE and GST_GL_ALPHA

`GST_GL_RED` (6403) –

Single component stored in the R texture component

`GST_GL_R8` (33321) –

Single 8-bit component stored in the R texture component

`GST_GL_RG` (33319) –

Two components stored in the R and G texture components

`GST_GL_RG8` (33323) –

Two 8-bit components stored in the R and G texture components

`GST_GL_RGB` (6407) –

Three components stored in the R, G, and B texture components

`GST_GL_RGB8` (32849) –

Three 8-bit components stored in the R, G, and B texture components

`GST_GL_RGB565` (36194) –

Three components of bit depth 5, 6 and 5 stored in the R, G, and B texture components respectively.

`GST_GL_RGB16` (32852) –

Three 16-bit components stored in the R, G, and B texture components

`GST_GL_RGBA` (6408) –

Four components stored in the R, G, B, and A texture components respectively.

`GST_GL_RGBA8` (32856) –

Four 8-bit components stored in the R, G, B, and A texture components respectively.

`GST_GL_RGBA16` (32859) –

Four 16-bit components stored in the R, G, B, and A texture components respectively.

`GST_GL_DEPTH_COMPONENT16` (33189) –

A single 16-bit component for depth information.

`GST_GL_DEPTH24_STENCIL8` (35056) –

A 24-bit component for depth information and a 8-bit component for stencil informat.

`GST_GL_RGB10_A2` (32857) –
No description available
`GST_GL_R16` (33322) –

Single 16-bit component stored in the R texture component

`GST_GL_RG16` (33324) –

Two 16-bit components stored in the R and G texture components

### GstGL.GLFormat

##### Members

`GstGL.GLFormat.LUMINANCE` (6409) –

Single component replicated across R, G, and B textures components

`GstGL.GLFormat.ALPHA` (6406) –

Single component stored in the A texture component

`GstGL.GLFormat.LUMINANCE_ALPHA` (6410) –

Combination of GstGL.GLFormat.LUMINANCE and GstGL.GLFormat.ALPHA

`GstGL.GLFormat.RED` (6403) –

Single component stored in the R texture component

`GstGL.GLFormat.R8` (33321) –

Single 8-bit component stored in the R texture component

`GstGL.GLFormat.RG` (33319) –

Two components stored in the R and G texture components

`GstGL.GLFormat.RG8` (33323) –

Two 8-bit components stored in the R and G texture components

`GstGL.GLFormat.RGB` (6407) –

Three components stored in the R, G, and B texture components

`GstGL.GLFormat.RGB8` (32849) –

Three 8-bit components stored in the R, G, and B texture components

`GstGL.GLFormat.RGB565` (36194) –

Three components of bit depth 5, 6 and 5 stored in the R, G, and B texture components respectively.

`GstGL.GLFormat.RGB16` (32852) –

Three 16-bit components stored in the R, G, and B texture components

`GstGL.GLFormat.RGBA` (6408) –

Four components stored in the R, G, B, and A texture components respectively.

`GstGL.GLFormat.RGBA8` (32856) –

Four 8-bit components stored in the R, G, B, and A texture components respectively.

`GstGL.GLFormat.RGBA16` (32859) –

Four 16-bit components stored in the R, G, B, and A texture components respectively.

`GstGL.GLFormat.DEPTH_COMPONENT16` (33189) –

A single 16-bit component for depth information.

`GstGL.GLFormat.DEPTH24_STENCIL8` (35056) –

A 24-bit component for depth information and a 8-bit component for stencil informat.

`GstGL.GLFormat.RGB10_A2` (32857) –
No description available
`GstGL.GLFormat.R16` (33322) –

Single 16-bit component stored in the R texture component

`GstGL.GLFormat.RG16` (33324) –

Two 16-bit components stored in the R and G texture components

### GstGL.GLFormat

##### Members

`GstGL.GLFormat.LUMINANCE` (6409) –

Single component replicated across R, G, and B textures components

`GstGL.GLFormat.ALPHA` (6406) –

Single component stored in the A texture component

`GstGL.GLFormat.LUMINANCE_ALPHA` (6410) –

Combination of GstGL.GLFormat.LUMINANCE and GstGL.GLFormat.ALPHA

`GstGL.GLFormat.RED` (6403) –

Single component stored in the R texture component

`GstGL.GLFormat.R8` (33321) –

Single 8-bit component stored in the R texture component

`GstGL.GLFormat.RG` (33319) –

Two components stored in the R and G texture components

`GstGL.GLFormat.RG8` (33323) –

Two 8-bit components stored in the R and G texture components

`GstGL.GLFormat.RGB` (6407) –

Three components stored in the R, G, and B texture components

`GstGL.GLFormat.RGB8` (32849) –

Three 8-bit components stored in the R, G, and B texture components

`GstGL.GLFormat.RGB565` (36194) –

Three components of bit depth 5, 6 and 5 stored in the R, G, and B texture components respectively.

`GstGL.GLFormat.RGB16` (32852) –

Three 16-bit components stored in the R, G, and B texture components

`GstGL.GLFormat.RGBA` (6408) –

Four components stored in the R, G, B, and A texture components respectively.

`GstGL.GLFormat.RGBA8` (32856) –

Four 8-bit components stored in the R, G, B, and A texture components respectively.

`GstGL.GLFormat.RGBA16` (32859) –

Four 16-bit components stored in the R, G, B, and A texture components respectively.

`GstGL.GLFormat.DEPTH_COMPONENT16` (33189) –

A single 16-bit component for depth information.

`GstGL.GLFormat.DEPTH24_STENCIL8` (35056) –

A 24-bit component for depth information and a 8-bit component for stencil informat.

`GstGL.GLFormat.RGB10_A2` (32857) –
No description available
`GstGL.GLFormat.R16` (33322) –

Single 16-bit component stored in the R texture component

`GstGL.GLFormat.RG16` (33324) –

Two 16-bit components stored in the R and G texture components

## Constants

### GST_BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_2D

    #define GST_BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_2D "GstBufferPoolOptionGLTextureTarget2D"

String used for GST_GL_TEXTURE_TARGET_2D as a GstBufferPool pool option

### GstGL.BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_2D

String used for GstGL.GLTextureTarget.2D as a Gst.BufferPool pool option

### GstGL.BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_2D

String used for GstGL.GLTextureTarget.2D as a Gst.BufferPool pool option

### GST_BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_EXTERNAL_OES

    #define GST_BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_EXTERNAL_OES "GstBufferPoolOptionGLTextureTargetExternalOES"

String used for GST_GL_TEXTURE_TARGET_EXTERNAL_OES as a GstBufferPool pool option

### GstGL.BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_EXTERNAL_OES

String used for GstGL.GLTextureTarget.EXTERNAL_OES as a Gst.BufferPool pool option

### GstGL.BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_EXTERNAL_OES

String used for GstGL.GLTextureTarget.EXTERNAL_OES as a Gst.BufferPool pool option

### GST_BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_RECTANGLE

    #define GST_BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_RECTANGLE "GstBufferPoolOptionGLTextureTargetRectangle"

String used for GST_GL_TEXTURE_TARGET_RECTANGLE as a GstBufferPool pool option

### GstGL.BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_RECTANGLE

String used for GstGL.GLTextureTarget.RECTANGLE as a Gst.BufferPool pool option

### GstGL.BUFFER_POOL_OPTION_GL_TEXTURE_TARGET_RECTANGLE

String used for GstGL.GLTextureTarget.RECTANGLE as a Gst.BufferPool pool option

### GST_GL_TEXTURE_TARGET_2D_STR

    #define GST_GL_TEXTURE_TARGET_2D_STR "2D"

String used for GST_GL_TEXTURE_TARGET_2D in things like caps values

### GstGL.GL_TEXTURE_TARGET_2D_STR

String used for GstGL.GLTextureTarget.2D in things like caps values

### GstGL.GL_TEXTURE_TARGET_2D_STR

String used for GstGL.GLTextureTarget.2D in things like caps values

### GST_GL_TEXTURE_TARGET_EXTERNAL_OES_STR

    #define GST_GL_TEXTURE_TARGET_EXTERNAL_OES_STR "external-oes"

String used for GST_GL_TEXTURE_TARGET_EXTERNAL_OES in things like caps values

### GstGL.GL_TEXTURE_TARGET_EXTERNAL_OES_STR

String used for GstGL.GLTextureTarget.EXTERNAL_OES in things like caps values

### GstGL.GL_TEXTURE_TARGET_EXTERNAL_OES_STR

String used for GstGL.GLTextureTarget.EXTERNAL_OES in things like caps values

### GST_GL_TEXTURE_TARGET_RECTANGLE_STR

    #define GST_GL_TEXTURE_TARGET_RECTANGLE_STR "rectangle"

String used for GST_GL_TEXTURE_TARGET_RECTANGLE in things like caps values

### GstGL.GL_TEXTURE_TARGET_RECTANGLE_STR

String used for GstGL.GLTextureTarget.RECTANGLE in things like caps values

### GstGL.GL_TEXTURE_TARGET_RECTANGLE_STR

String used for GstGL.GLTextureTarget.RECTANGLE in things like caps values

The results of the search are