QOpenGLTexture: better document the depth/stencil features

For some reason these docs were missing, add them.

Change-Id: If17cf429925ee849a0817e0294a7db7f6dace79b
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
This commit is contained in:
Giuseppe D'Angelo 2015-01-14 00:01:42 +01:00 committed by Thiago Macieira
parent e884ecf6d1
commit 0d65bf4f9f

View File

@ -3576,6 +3576,16 @@ QOpenGLTexture::SwizzleValue QOpenGLTexture::swizzleMask(SwizzleComponent compon
return d->swizzleMask[component - SwizzleRed];
}
/*!
\enum QOpenGLTexture::DepthStencilMode
\since 5.4
This enum specifies which component of a depth/stencil texture is
accessed when the texture is sampled.
\value DepthMode Equivalent to GL_DEPTH_COMPONENT.
\value StencilMode Equivalent to GL_STENCIL_INDEX.
*/
/*!
If using a texture that has a combined depth/stencil format this function sets
which component of the texture is accessed to \a mode.
@ -3585,6 +3595,7 @@ QOpenGLTexture::SwizzleValue QOpenGLTexture::swizzleMask(SwizzleComponent compon
the parameter is set to StencilMode, the shader will access the stencil component.
\note This function has no effect on Mac and Qt built for OpenGL ES 2.
\since 5.4
\sa depthStencilMode()
*/
void QOpenGLTexture::setDepthStencilMode(QOpenGLTexture::DepthStencilMode mode)
@ -3612,6 +3623,7 @@ void QOpenGLTexture::setDepthStencilMode(QOpenGLTexture::DepthStencilMode mode)
/*!
Returns the depth stencil mode for textures using a combined depth/stencil format.
\since 5.4
\sa setDepthStencilMode()
*/
QOpenGLTexture::DepthStencilMode QOpenGLTexture::depthStencilMode() const