diff options
| author | Matthew Waters <matthew@centricular.com> | 2016-11-03 12:03:24 +1100 |
|---|---|---|
| committer | Matthew Waters <matthew@centricular.com> | 2016-11-03 16:16:11 +1100 |
| commit | 0dc003bf30b0b5a85604646b5343bb52e3b0a4e2 (patch) | |
| tree | 5382bd7d04b6db04cf1ff7bffa291c57d4c1cce7 /gst-libs/gst/gl/gstglsl.h | |
| parent | 1296741d3d8d8cdf7a18fec3c35dda467250c922 (diff) | |
gl/docs: massive update
- add Since: markers where necessary.
- document structs
- add documentation headers for each module (short_description,
see_also, etc)
- reduce the number of warnings gtk-doc outputs
- fix spelling mistakes
Diffstat (limited to 'gst-libs/gst/gl/gstglsl.h')
| -rw-r--r-- | gst-libs/gst/gl/gstglsl.h | 48 |
1 files changed, 46 insertions, 2 deletions
diff --git a/gst-libs/gst/gl/gstglsl.h b/gst-libs/gst/gl/gstglsl.h index 097fea254..4d5a7545a 100644 --- a/gst-libs/gst/gl/gstglsl.h +++ b/gst-libs/gst/gl/gstglsl.h @@ -29,12 +29,46 @@ GST_EXPORT GQuark gst_glsl_error_quark (void); #define GST_GLSL_ERROR (gst_glsl_error_quark ()) +/** + * GstGLSLError: + * @GST_GLSL_ERROR_COMPILE: Compilation error occured + * @GST_GLSL_ERROR_LINK: Link error occured + * @GST_GLSL_ERROR_PROGRAM: General program error occured + * + * Compilation stage that caused an error + * + * Since: 1.8 + */ typedef enum { GST_GLSL_ERROR_COMPILE, GST_GLSL_ERROR_LINK, GST_GLSL_ERROR_PROGRAM, } GstGLSLError; +/** + * GstGLSLVersion: + * @GST_GLSL_VERSION_NONE: no version + * @GST_GLSL_VERSION_100: #version 100 (only valid for ES) + * @GST_GLSL_VERSION_110: #version 110 (only valid for compatibility desktop GL) + * @GST_GLSL_VERSION_120: #version 120 (only valid for compatibility desktop GL) + * @GST_GLSL_VERSION_130: #version 130 (only valid for compatibility desktop GL) + * @GST_GLSL_VERSION_140: #version 140 (only valid for compatibility desktop GL) + * @GST_GLSL_VERSION_150: #version 150 (valid for compatibility/core desktop GL) + * @GST_GLSL_VERSION_300: #version 300 (only valid for ES) + * @GST_GLSL_VERSION_310: #version 310 (only valid for ES) + * @GST_GLSL_VERSION_320: #version 320 (only valid for ES) + * @GST_GLSL_VERSION_330: #version 330 (valid for compatibility/core desktop GL) + * @GST_GLSL_VERSION_400: #version 400 (valid for compatibility/core desktop GL) + * @GST_GLSL_VERSION_410: #version 410 (valid for compatibility/core desktop GL) + * @GST_GLSL_VERSION_420: #version 420 (valid for compatibility/core desktop GL) + * @GST_GLSL_VERSION_430: #version 430 (valid for compatibility/core desktop GL) + * @GST_GLSL_VERSION_440: #version 440 (valid for compatibility/core desktop GL) + * @GST_GLSL_VERSION_450: #version 450 (valid for compatibility/core desktop GL) + * + * GLSL version list + * + * Since: 1.8 + */ typedef enum { GST_GLSL_VERSION_NONE = 0, @@ -55,10 +89,20 @@ typedef enum GST_GLSL_VERSION_430 = 430, /* GL */ GST_GLSL_VERSION_440 = 440, /* GL */ GST_GLSL_VERSION_450 = 450, /* GL */ - - GST_GLSL_VERSION_ANY = -1, } GstGLSLVersion; +/** + * GstGLSLProfile: + * @GST_GLSL_PROFILE_NONE: no profile supported/available + * @GST_GLSL_PROFILE_ES: OpenGL|ES profile + * @GST_GLSL_PROFILE_CORE: OpenGL core profile + * @GST_GLSL_PROFILE_COMPATIBILITY: OpenGL compatibility profile + * @GST_GLSL_PROFILE_ANY: any OpenGL/OpenGL|ES profile + * + * GLSL profiles + * + * Since: 1.8 + */ typedef enum { /* XXX: maybe make GstGLAPI instead */ |