src/mesa/main/multisample.c

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2007  Brian Paul   All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25
  26 #include "main/glheader.h"
  27 #include "main/context.h"
  28 #include "main/macros.h"
  29 #include "main/multisample.h"
  30 #include "main/mtypes.h"
  31 #include "main/fbobject.h"
  32 #include "main/glformats.h"
  33 #include "main/state.h"
  34
  35
  36 /**
  37  * Called via glSampleCoverageARB
  38  */
  39 void GLAPIENTRY
  40 _mesa_SampleCoverage(GLclampf value, GLboolean invert)
  41 {
  42    GET_CURRENT_CONTEXT(ctx);
  43
  44    value = CLAMP(value, 0.0f, 1.0f);
  45
  46    if (ctx->Multisample.SampleCoverageInvert == invert &&
  47        ctx->Multisample.SampleCoverageValue == value)
  48       return;
  49
  50    FLUSH_VERTICES(ctx, ctx->DriverFlags.NewSampleMask ? 0 : _NEW_MULTISAMPLE);
  51    ctx->NewDriverState |= ctx->DriverFlags.NewSampleMask;
  52    ctx->Multisample.SampleCoverageValue = value;
  53    ctx->Multisample.SampleCoverageInvert = invert;
  54 }
  55
  56
  57 /**
  58  * Initialize the context's multisample state.
  59  * \param ctx  the GL context.
  60  */
  61 void
  62 _mesa_init_multisample(struct gl_context *ctx)
  63 {
  64    ctx->Multisample.Enabled = GL_TRUE;
  65    ctx->Multisample.SampleAlphaToCoverage = GL_FALSE;
  66    ctx->Multisample.SampleAlphaToOne = GL_FALSE;
  67    ctx->Multisample.SampleCoverage = GL_FALSE;
  68    ctx->Multisample.SampleCoverageValue = 1.0;
  69    ctx->Multisample.SampleCoverageInvert = GL_FALSE;
  70    ctx->Multisample.SampleShading = GL_FALSE;
  71    ctx->Multisample.MinSampleShadingValue = 0.0f;
  72
  73    /* ARB_texture_multisample / GL3.2 additions */
  74    ctx->Multisample.SampleMask = GL_FALSE;
  75    ctx->Multisample.SampleMaskValue = ~(GLbitfield)0;
  76 }
  77
  78
  79 void GLAPIENTRY
  80 _mesa_GetMultisamplefv(GLenum pname, GLuint index, GLfloat * val)
  81 {
  82    GET_CURRENT_CONTEXT(ctx);
  83
  84    if (ctx->NewState & _NEW_BUFFERS) {
  85       _mesa_update_state(ctx);
  86    }
  87
  88    switch (pname) {
  89    case GL_SAMPLE_POSITION: {
  90       if (index >= ctx->DrawBuffer->Visual.samples) {
  91          _mesa_error( ctx, GL_INVALID_VALUE, "glGetMultisamplefv(index)" );
  92          return;
  93       }
  94
  95       ctx->Driver.GetSamplePosition(ctx, ctx->DrawBuffer, index, val);
  96
  97       /* winsys FBOs are upside down */
  98       if (_mesa_is_winsys_fbo(ctx->DrawBuffer))
  99          val[1] = 1.0f - val[1];
 100
 101       return;
 102    }
 103
 104    case GL_PROGRAMMABLE_SAMPLE_LOCATION_ARB:
 105       if (!ctx->Extensions.ARB_sample_locations) {
 106          _mesa_error( ctx, GL_INVALID_ENUM, "glGetMultisamplefv(pname)" );
 107          return;
 108       }
 109
 110       if (index >= MAX_SAMPLE_LOCATION_TABLE_SIZE * 2) {
 111          _mesa_error( ctx, GL_INVALID_VALUE, "glGetMultisamplefv(index)" );
 112          return;
 113       }
 114
 115       if (ctx->DrawBuffer->SampleLocationTable)
 116          *val = ctx->DrawBuffer->SampleLocationTable[index];
 117       else
 118          *val = 0.5f;
 119
 120       return;
 121
 122    default:
 123       _mesa_error( ctx, GL_INVALID_ENUM, "glGetMultisamplefv(pname)" );
 124       return;
 125    }
 126 }
 127
 128 static void
 129 sample_maski(struct gl_context *ctx, GLuint index, GLbitfield mask)
 130 {
 131    if (ctx->Multisample.SampleMaskValue == mask)
 132       return;
 133
 134    FLUSH_VERTICES(ctx, ctx->DriverFlags.NewSampleMask ? 0 : _NEW_MULTISAMPLE);
 135    ctx->NewDriverState |= ctx->DriverFlags.NewSampleMask;
 136    ctx->Multisample.SampleMaskValue = mask;
 137 }
 138
 139 void GLAPIENTRY
 140 _mesa_SampleMaski_no_error(GLuint index, GLbitfield mask)
 141 {
 142    GET_CURRENT_CONTEXT(ctx);
 143    sample_maski(ctx, index, mask);
 144 }
 145
 146 void GLAPIENTRY
 147 _mesa_SampleMaski(GLuint index, GLbitfield mask)
 148 {
 149    GET_CURRENT_CONTEXT(ctx);
 150
 151    if (!ctx->Extensions.ARB_texture_multisample) {
 152       _mesa_error(ctx, GL_INVALID_OPERATION, "glSampleMaski");
 153       return;
 154    }
 155
 156    if (index != 0) {
 157       _mesa_error(ctx, GL_INVALID_VALUE, "glSampleMaski(index)");
 158       return;
 159    }
 160
 161    sample_maski(ctx, index, mask);
 162 }
 163
 164 static void
 165 min_sample_shading(struct gl_context *ctx, GLclampf value)
 166 {
 167    value = CLAMP(value, 0.0f, 1.0f);
 168
 169    if (ctx->Multisample.MinSampleShadingValue == value)
 170       return;
 171
 172    FLUSH_VERTICES(ctx,
 173                   ctx->DriverFlags.NewSampleShading ? 0 : _NEW_MULTISAMPLE);
 174    ctx->NewDriverState |= ctx->DriverFlags.NewSampleShading;
 175    ctx->Multisample.MinSampleShadingValue = value;
 176 }
 177
 178 /**
 179  * Called via glMinSampleShadingARB
 180  */
 181 void GLAPIENTRY
 182 _mesa_MinSampleShading_no_error(GLclampf value)
 183 {
 184    GET_CURRENT_CONTEXT(ctx);
 185    min_sample_shading(ctx, value);
 186 }
 187
 188 void GLAPIENTRY
 189 _mesa_MinSampleShading(GLclampf value)
 190 {
 191    GET_CURRENT_CONTEXT(ctx);
 192
 193    if (!_mesa_has_ARB_sample_shading(ctx) &&
 194        !_mesa_has_OES_sample_shading(ctx)) {
 195       _mesa_error(ctx, GL_INVALID_OPERATION, "glMinSampleShading");
 196       return;
 197    }
 198
 199    min_sample_shading(ctx, value);
 200 }
 201
 202 /**
 203  * Helper for checking a requested sample count against the limit
 204  * for a particular (target, internalFormat) pair. The limit imposed,
 205  * and the error generated, both depend on which extensions are supported.
 206  *
 207  * Returns a GL error enum, or GL_NO_ERROR if the requested sample count is
 208  * acceptable.
 209  */
 210 GLenum
 211 _mesa_check_sample_count(struct gl_context *ctx, GLenum target,
 212                          GLenum internalFormat, GLsizei samples)
 213 {
 214    /* Section 4.4 (Framebuffer objects), page 198 of the OpenGL ES 3.0.0
 215     * specification says:
 216     *
 217     *     "If internalformat is a signed or unsigned integer format and samples
 218     *     is greater than zero, then the error INVALID_OPERATION is generated."
 219     *
 220     * This restriction is relaxed for OpenGL ES 3.1.
 221     */
 222    if ((ctx->API == API_OPENGLES2 && ctx->Version == 30) &&
 223        _mesa_is_enum_format_integer(internalFormat)
 224        && samples > 0) {
 225       return GL_INVALID_OPERATION;
 226    }
 227
 228    /* If ARB_internalformat_query is supported, then treat its highest
 229     * returned sample count as the absolute maximum for this format; it is
 230     * allowed to exceed MAX_SAMPLES.
 231     *
 232     * From the ARB_internalformat_query spec:
 233     *
 234     * "If <samples is greater than the maximum number of samples supported
 235     * for <internalformat> then the error INVALID_OPERATION is generated."
 236     */
 237    if (ctx->Extensions.ARB_internalformat_query) {
 238       GLint buffer[16] = {-1};
 239       GLint limit;
 240
 241       ctx->Driver.QueryInternalFormat(ctx, target, internalFormat,
 242                                       GL_SAMPLES, buffer);
 243       /* since the query returns samples sorted in descending order,
 244        * the first element is the greatest supported sample value.
 245        */
 246       limit = buffer[0];
 247
 248       return samples > limit ? GL_INVALID_OPERATION : GL_NO_ERROR;
 249    }
 250
 251    /* If ARB_texture_multisample is supported, we have separate limits,
 252     * which may be lower than MAX_SAMPLES:
 253     *
 254     * From the ARB_texture_multisample spec, when describing the operation
 255     * of RenderbufferStorageMultisample:
 256     *
 257     * "If <internalformat> is a signed or unsigned integer format and
 258     * <samples> is greater than the value of MAX_INTEGER_SAMPLES, then the
 259     * error INVALID_OPERATION is generated"
 260     *
 261     * And when describing the operation of TexImage*Multisample:
 262     *
 263     * "The error INVALID_OPERATION may be generated if any of the following
 264     * are true:
 265     *
 266     * * <internalformat> is a depth/stencil-renderable format and <samples>
 267     *   is greater than the value of MAX_DEPTH_TEXTURE_SAMPLES
 268     * * <internalformat> is a color-renderable format and <samples> is
 269     *   grater than the value of MAX_COLOR_TEXTURE_SAMPLES
 270     * * <internalformat> is a signed or unsigned integer format and
 271     *   <samples> is greater than the value of MAX_INTEGER_SAMPLES
 272     */
 273
 274    if (ctx->Extensions.ARB_texture_multisample) {
 275       if (_mesa_is_enum_format_integer(internalFormat))
 276          return samples > ctx->Const.MaxIntegerSamples
 277             ? GL_INVALID_OPERATION : GL_NO_ERROR;
 278
 279       if (target == GL_TEXTURE_2D_MULTISAMPLE ||
 280           target == GL_TEXTURE_2D_MULTISAMPLE_ARRAY) {
 281
 282          if (_mesa_is_depth_or_stencil_format(internalFormat))
 283             return samples > ctx->Const.MaxDepthTextureSamples
 284                ? GL_INVALID_OPERATION : GL_NO_ERROR;
 285          else
 286             return samples > ctx->Const.MaxColorTextureSamples
 287                ? GL_INVALID_OPERATION : GL_NO_ERROR;
 288       }
 289    }
 290
 291    /* No more specific limit is available, so just use MAX_SAMPLES:
 292     *
 293     * On p205 of the GL3.1 spec:
 294     *
 295     * "... or if samples is greater than MAX_SAMPLES, then the error
 296     * INVALID_VALUE is generated"
 297     */
 298    return (GLuint) samples > ctx->Const.MaxSamples
 299       ? GL_INVALID_VALUE : GL_NO_ERROR;
 300 }