Light | Dark

# docs.GL

OpenGL 4
OpenGL 3

# glGetMultisample

## Name

glGetMultisamplefv — retrieve the location of a sample

## C Specification

`void glGetMultisamplefv(` | GLenum pname,
| GLuint index,
| GLfloat *val`)`;

## Parameters

`pname`

  Specifies the sample parameter name. `pname` must be `GL_SAMPLE_POSITION`.

`index`

  Specifies the index of the sample whose position to query.

`val`

  Specifies the address of an array to receive the position of the sample.

## Description

`glGetMultisamplefv` queries the location of a given sample. `pname` specifies the sample parameter to retrieve and must be `GL_SAMPLE_POSITION`. `index` corresponds to the sample for which the location should be returned. The sample location is returned as two floating-point values in `val[0]` and `val[1]`, each between 0 and 1, corresponding to the `x` and `y` locations respectively in the GL pixel space of that sample. (0.5, 0.5) this corresponds to the pixel center. `index` must be between zero and the value of `GL_SAMPLES` - 1.

If the multisample mode does not have fixed sample locations, the returned values may only reflect the locations of samples within some pixels.

## Errors

`GL_INVALID_ENUM` is generated if `pname` is not one `GL_SAMPLE_POSITION`.

`GL_INVALID_VALUE` is generated if `index` is greater than or equal to the value of `GL_SAMPLES`.

## See Also

glGenFramebuffers, glBindFramebuffer

## Copyright

Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. https://opencontent.org/openpub/.

Think you can improve this page? Edit this page on GitHub.