GstGLContext

GstGL.GLContext

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──GstGL.GLContext

GstGL.GLContext.prototype.new

function GstGL.GLContext.prototype.new(display: GstGL.GLDisplay): {
    // javascript wrapper for 'gst_gl_context_new'
}

Create a new GstGL.GLContext with the specified display

Since : 1.4

GstGL.GLContext.prototype.new_wrapped

function GstGL.GLContext.prototype.new_wrapped(display: GstGL.GLDisplay, handle: Number, context_type: GstGL.GLPlatform, available_apis: GstGL.GLAPI): {
    // javascript wrapper for 'gst_gl_context_new_wrapped'
}

Wraps an existing OpenGL context into a GstGL.GLContext.

Note: The caller is responsible for ensuring that the OpenGL context represented by handle stays alive while the returned GstGL.GLContext is active.

context_type must not be GstGL.GLPlatform.NONE or GstGL.GLPlatform.ANY

available_apis must not be GstGL.GLAPI.NONE or GstGL.GLAPI.ANY

Since : 1.4

GstGL.GLContext.prototype.activate

function GstGL.GLContext.prototype.activate(activate: Number): {
    // javascript wrapper for 'gst_gl_context_activate'
}

(De)activate the OpenGL context represented by this context.

In OpenGL terms, calls eglMakeCurrent or similar with this context and the currently set window. See GstGL.GLContext.prototype.set_window for details.

Since : 1.4

GstGL.GLContext.prototype.can_share

function GstGL.GLContext.prototype.can_share(other_context: GstGL.GLContext): {
    // javascript wrapper for 'gst_gl_context_can_share'
}

Note: This will always fail for two wrapped GstGL.GLContext's

Since : 1.6

GstGL.GLContext.prototype.check_feature

function GstGL.GLContext.prototype.check_feature(feature: String): {
    // javascript wrapper for 'gst_gl_context_check_feature'
}

Check for an OpenGL feature being supported.

Note: Most features require that the context be created before it is possible to determine their existence and so will fail if that is not the case.

Since : 1.4

GstGL.GLContext.prototype.check_framebuffer_status

function GstGL.GLContext.prototype.check_framebuffer_status(fbo_target: Number): {
    // javascript wrapper for 'gst_gl_context_check_framebuffer_status'
}

Must be called with context current.

Since : 1.10

GstGL.GLContext.prototype.check_gl_version

function GstGL.GLContext.prototype.check_gl_version(api: GstGL.GLAPI, maj: Number, min: Number): {
    // javascript wrapper for 'gst_gl_context_check_gl_version'
}

Since : 1.4

GstGL.GLContext.prototype.clear_framebuffer

function GstGL.GLContext.prototype.clear_framebuffer(): {
    // javascript wrapper for 'gst_gl_context_clear_framebuffer'
}

Unbind the current framebuffer

Since : 1.10

GstGL.GLContext.prototype.clear_shader

function GstGL.GLContext.prototype.clear_shader(): {
    // javascript wrapper for 'gst_gl_context_clear_shader'
}

Clear's the currently set shader from the GL state machine.

Note: must be called in the GL thread.

GstGL.GLContext.prototype.create

function GstGL.GLContext.prototype.create(other_context: GstGL.GLContext): {
    // javascript wrapper for 'gst_gl_context_create'
}

Creates an OpenGL context with the specified other_context as a context to share shareable OpenGL objects with. See the OpenGL specification for what is shared between OpenGL contexts.

Since 1.20, the configuration can be overriden with the environment variable GST_GL_CONFIG which is a stringified Gst.Structure as would be returned from GstGL.GLContext.prototype.get_config. If GST_GL_CONFIG is not set, then the config will be chosen from other_context by calling GstGL.GLContext.prototype.get_config on other_context. Otherwise, a default configuration is used.

Calling GstGL.GLContext.prototype.request_config) before calling GstGL.GLContext.prototype.create will override the config from other_context but will not override the GST_GL_CONFIG environment variable.

If an error occurs, and error is not null, then error will contain details of the error and false will be returned.

Should only be called once.

Since : 1.4

GstGL.GLContext.prototype.destroy

function GstGL.GLContext.prototype.destroy(): {
    // javascript wrapper for 'gst_gl_context_destroy'
}

Destroys an OpenGL context.

Should only be called after GstGL.GLContext.prototype.create has been successfully called for this context.

Since : 1.6

GstGL.GLContext.prototype.fill_info

function GstGL.GLContext.prototype.fill_info(): {
    // javascript wrapper for 'gst_gl_context_fill_info'
}

Fills context's info (version, extensions, vtable, etc) from the GL context in the current thread. Typically used with wrapped contexts to allow wrapped contexts to be used as regular GstGL.GLContext's.

Since : 1.6

GstGL.GLContext.prototype.get_config

function GstGL.GLContext.prototype.get_config(): {
    // javascript wrapper for 'gst_gl_context_get_config'
}

Retrieve the OpenGL configuration for this context. The context must have been successfully created for this function to return a valid value.

Not all implementations currently support retrieving the config and will return null when not supported.

Since : 1.20

GstGL.GLContext.prototype.get_display

function GstGL.GLContext.prototype.get_display(): {
    // javascript wrapper for 'gst_gl_context_get_display'
}

Since : 1.4

GstGL.GLContext.prototype.get_gl_api

function GstGL.GLContext.prototype.get_gl_api(): {
    // javascript wrapper for 'gst_gl_context_get_gl_api'
}

Get the currently enabled OpenGL api.

The currently available API may be limited by the GstGL.GLDisplay in use and/or the GstGL.GLWindow chosen.

Since : 1.4

GstGL.GLContext.prototype.get_gl_context

function GstGL.GLContext.prototype.get_gl_context(): {
    // javascript wrapper for 'gst_gl_context_get_gl_context'
}

Gets the backing OpenGL context used by context.

Since : 1.4

GstGL.GLContext.prototype.get_gl_platform

function GstGL.GLContext.prototype.get_gl_platform(): {
    // javascript wrapper for 'gst_gl_context_get_gl_platform'
}

Gets the OpenGL platform that used by context.

Since : 1.4

GstGL.GLContext.prototype.get_gl_platform_version

function GstGL.GLContext.prototype.get_gl_platform_version(): {
    // javascript wrapper for 'gst_gl_context_get_gl_platform_version'
}

Get the version of the OpenGL platform (GLX, EGL, etc) used. Only valid after a call to GstGL.GLContext.prototype.create.

GstGL.GLContext.prototype.get_gl_version

function GstGL.GLContext.prototype.get_gl_version(): {
    // javascript wrapper for 'gst_gl_context_get_gl_version'
}

Returns the OpenGL version implemented by context. See GstGL.GLContext.prototype.get_gl_api for retrieving the OpenGL api implemented by context.

Since : 1.4

GstGL.GLContext.prototype.get_proc_address

function GstGL.GLContext.prototype.get_proc_address(name: String): {
    // javascript wrapper for 'gst_gl_context_get_proc_address'
}

Get a function pointer to a specified opengl function, name. If the the specific function does not exist, NULL is returned instead.

Platform specific functions (names starting 'egl', 'glX', 'wgl', etc) can also be retrieved using this method.

Note: This function may return valid function pointers that may not be valid to call in context. The caller is responsible for ensuring that the returned function is a valid function to call in context by either checking the OpenGL API and version or for an appropriate OpenGL extension.

Note: On success, you need to cast the returned function pointer to the correct type to be able to call it correctly. On 32-bit Windows, this will include the GSTGLAPI identifier to use the correct calling convention. e.g.

 void (GSTGLAPI *PFN_glGetIntegerv) (GLenum name, GLint * ret)

Since : 1.4

GstGL.GLContext.prototype.get_thread

function GstGL.GLContext.prototype.get_thread(): {
    // javascript wrapper for 'gst_gl_context_get_thread'
}

Since : 1.6

GstGL.GLContext.prototype.get_window

function GstGL.GLContext.prototype.get_window(): {
    // javascript wrapper for 'gst_gl_context_get_window'
}

Since : 1.4

GstGL.GLContext.prototype.is_shared

function GstGL.GLContext.prototype.is_shared(): {
    // javascript wrapper for 'gst_gl_context_is_shared'
}

Since : 1.8

GstGL.GLContext.prototype.request_config

function GstGL.GLContext.prototype.request_config(gl_config: Gst.Structure): {
    // javascript wrapper for 'gst_gl_context_request_config'
}

Set the OpenGL configuration for this context. The context must not have been created for this function to succeed. Setting a null config has the affect of removing any specific configuration request.

Not all implementations currently support retrieving the config and this function will return FALSE when not supported.

Note that calling this function may cause a subsequent GstGL.GLContext.prototype.create to fail if config could not be matched with the platform-specific configuration.

Note that the actual config used may be differ from the requested values.

Since : 1.20

GstGL.GLContext.prototype.set_shared_with

function GstGL.GLContext.prototype.set_shared_with(share: GstGL.GLContext): {
    // javascript wrapper for 'gst_gl_context_set_shared_with'
}

Will internally set context as shared with share

Since : 1.8

GstGL.GLContext.prototype.set_window

function GstGL.GLContext.prototype.set_window(window: GstGL.GLWindow): {
    // javascript wrapper for 'gst_gl_context_set_window'
}

Set's the current window on context to window. The window can only be changed before GstGL.GLContext.prototype.create has been called and the window is not already running.

Since : 1.4

GstGL.GLContext.prototype.supports_glsl_profile_version

function GstGL.GLContext.prototype.supports_glsl_profile_version(version: GstGL.GLSLVersion, profile: GstGL.GLSLProfile): {
    // javascript wrapper for 'gst_gl_context_supports_glsl_profile_version'
}

GstGL.GLContext.prototype.supports_precision

function GstGL.GLContext.prototype.supports_precision(version: GstGL.GLSLVersion, profile: GstGL.GLSLProfile): {
    // javascript wrapper for 'gst_gl_context_supports_precision'
}

Since : 1.16

GstGL.GLContext.prototype.supports_precision_highp

function GstGL.GLContext.prototype.supports_precision_highp(version: GstGL.GLSLVersion, profile: GstGL.GLSLProfile): {
    // javascript wrapper for 'gst_gl_context_supports_precision_highp'
}

Since : 1.16

GstGL.GLContext.prototype.swap_buffers

function GstGL.GLContext.prototype.swap_buffers(): {
    // javascript wrapper for 'gst_gl_context_swap_buffers'
}

Swap the front and back buffers on the window attached to context. This will display the frame on the next refresh cycle.

GstGL.GLContext.prototype.thread_add

function GstGL.GLContext.prototype.thread_add(func: GstGL.GLContextThreadFunc, data: Object): {
    // javascript wrapper for 'gst_gl_context_thread_add'
}

Execute func in the OpenGL thread of context with data

MT-safe

Since : 1.4

GstGL.GLContext.prototype.default_get_proc_address

function GstGL.GLContext.prototype.default_get_proc_address(gl_api: GstGL.GLAPI, name: String): {
    // javascript wrapper for 'gst_gl_context_default_get_proc_address'
}

A default implementation of the various GetProcAddress functions that looks for name in the OpenGL shared libraries or in the current process.

See also: GstGL.GLContext.prototype.get_proc_address

Since : 1.4

GstGL.GLContext.prototype.get_current

function GstGL.GLContext.prototype.get_current(): {
    // javascript wrapper for 'gst_gl_context_get_current'
}

See also GstGL.GLContext.prototype.activate.

Since : 1.6

GstGL.GLContext.prototype.get_current_gl_api

function GstGL.GLContext.prototype.get_current_gl_api(platform: GstGL.GLPlatform): {
    // javascript wrapper for 'gst_gl_context_get_current_gl_api'
}

If an error occurs, major and minor are not modified and GstGL.GLAPI.NONE is returned.

Since : 1.6

GstGL.GLContext.prototype.get_current_gl_context

function GstGL.GLContext.prototype.get_current_gl_context(context_type: GstGL.GLPlatform): {
    // javascript wrapper for 'gst_gl_context_get_current_gl_context'
}

Since : 1.6

GstGL.GLContext.prototype.get_proc_address_with_platform

function GstGL.GLContext.prototype.get_proc_address_with_platform(context_type: GstGL.GLPlatform, gl_api: GstGL.GLAPI, name: String): {
    // javascript wrapper for 'gst_gl_context_get_proc_address_with_platform'
}

Attempts to use the context_type specific GetProcAddress implementations to retrieve name.

See also GstGL.GLContext.prototype.get_proc_address.

Since : 1.6

vfunc_activate

function vfunc_activate(context: GstGL.GLContext, activate: Number): {
    // javascript implementation of the 'activate' virtual method
}

call eglMakeCurrent or similar

vfunc_check_feature

function vfunc_check_feature(context: GstGL.GLContext, feature: String): {
    // javascript implementation of the 'check_feature' virtual method
}

vfunc_choose_format

function vfunc_choose_format(context: GstGL.GLContext): {
    // javascript implementation of the 'choose_format' virtual method
}

choose a format for the framebuffer

vfunc_create_context

function vfunc_create_context(context: GstGL.GLContext, gl_api: GstGL.GLAPI, other_context: GstGL.GLContext): {
    // javascript implementation of the 'create_context' virtual method
}

create the OpenGL context

vfunc_destroy_context

function vfunc_destroy_context(context: GstGL.GLContext): {
    // javascript implementation of the 'destroy_context' virtual method
}

destroy the OpenGL context

vfunc_get_config

function vfunc_get_config(context: GstGL.GLContext): {
    // javascript implementation of the 'get_config' virtual method
}

Retrieve the configuration in use by this context. See also GstGL.GLContext.prototype.get_config.

Since : 1.20

vfunc_get_gl_api

function vfunc_get_gl_api(context: GstGL.GLContext): {
    // javascript implementation of the 'get_gl_api' virtual method
}

get the available OpenGL api's that this context can work with

vfunc_get_gl_context

function vfunc_get_gl_context(context: GstGL.GLContext): {
    // javascript implementation of the 'get_gl_context' virtual method
}

get the backing platform specific OpenGL context

vfunc_get_gl_platform

function vfunc_get_gl_platform(context: GstGL.GLContext): {
    // javascript implementation of the 'get_gl_platform' virtual method
}

vfunc_get_gl_platform_version

function vfunc_get_gl_platform_version(context: GstGL.GLContext): {
    // javascript implementation of the 'get_gl_platform_version' virtual method
}

vfunc_request_config

function vfunc_request_config(context: GstGL.GLContext, gl_config: Gst.Structure): {
    // javascript implementation of the 'request_config' virtual method
}

Request a configuration for this context to use.

Unknown fields within gl_config should be ignored by subclasses.

See also GstGL.GLContext.prototype.request_config.

Since : 1.20

vfunc_swap_buffers

function vfunc_swap_buffers(context: GstGL.GLContext): {
    // javascript implementation of the 'swap_buffers' virtual method
}

swap the default framebuffer's front/back buffers

GstGL.prototype.gl_context_error_quark

function GstGL.prototype.gl_context_error_quark(): {
    // javascript wrapper for 'gst_gl_context_error_quark'
}

GstGL.GLContextError

OpenGL context errors.

GstGL.GL_CONTEXT_TYPE_CGL

GstGL.GL_CONTEXT_TYPE_EAGL

GstGL.GL_CONTEXT_TYPE_EGL

GstGL.GL_CONTEXT_TYPE_GLX

GstGL.GL_CONTEXT_TYPE_WGL

GstGL.GLContextThreadFunc

function GstGL.GLContextThreadFunc(context: GstGL.GLContext, data: Object): {
    // javascript wrapper for 'GstGLContextThreadFunc'
}

Represents a function to run in the GL thread with context and data