Browse Source

GL: document that Luminance formats can't be used in framebuffers.

pull/168/head
Vladimír Vondruš 3 years ago
parent
commit
b57979150e
  1. 5
      src/Magnum/GL/PixelFormat.h
  2. 6
      src/Magnum/GL/TextureFormat.h

5
src/Magnum/GL/PixelFormat.h

@ -97,7 +97,7 @@ enum class PixelFormat: GLenum {
#if defined(MAGNUM_TARGET_GLES2) || defined(DOXYGEN_GENERATING_OUTPUT)
/**
* Floating-point luminance channel. The value is used for all RGB
* channels.
* channels. Can't be used for framebuffer reading.
* @requires_gles20_only Not available in ES 3.0, WebGL 2.0 or desktop
* OpenGL. Use @ref PixelFormat::Red instead.
* @deprecated_gl Included for compatibility reasons only, use
@ -127,7 +127,8 @@ enum class PixelFormat: GLenum {
#if defined(MAGNUM_TARGET_GLES2) || defined(DOXYGEN_GENERATING_OUTPUT)
/**
* Floating-point luminance and alpha channel. First value is used for all
* RGB channels, second value is used for alpha channel.
* RGB channels, second value is used for alpha channel. Can't be used for
* framebuffer reading.
* @requires_gles20_only Not available in ES 3.0, WebGL 2.0 or desktop
* OpenGL. Use @ref PixelFormat::RG instead.
* @deprecated_gl Included for compatibility reasons only, use

6
src/Magnum/GL/TextureFormat.h

@ -922,7 +922,8 @@ enum class TextureFormat: GLenum {
/**
* Luminance, normalized unsigned, single value used for all RGB channels.
* Size implementation-dependent. Not allowed in unemulated
* @ref Texture::setStorage() "*Texture::setStorage()" calls.
* @ref Texture::setStorage() "*Texture::setStorage()" calls. Can't be used
* for framebuffer attachments.
* @requires_gles20_only Not available in OpenGL ES 3.0, WebGL 2.0 or
* desktop OpenGL. Use @ref TextureFormat::R8 instead.
* @deprecated_gl Included for compatibility reasons only, use
@ -934,7 +935,8 @@ enum class TextureFormat: GLenum {
* Floating-point luminance and alpha channel. First value is used for all
* RGB channels, second value is used for alpha channel. Size
* implementation-dependent. Not allowed in unemulated
* @ref Texture::setStorage() "*Texture::setStorage()" calls.
* @ref Texture::setStorage() "*Texture::setStorage()" calls. Can't be used
* for framebuffer attachments.
* @requires_gles20_only Not available in OpenGL ES 3.0, WebGL 2.0 or
* desktop OpenGL. Use @ref TextureFormat::RG8 instead.
* @deprecated_gl Included for compatibility reasons only, use

Loading…
Cancel
Save