GLGETSAMPLERPARAMETE(3G)

📦
version 1.1 · 7 versions
, in centos-stream 9

💅 GLGETSAMPLERPARAMETE(3G) — the OpenGL manual, section 3G, bestie

okay so real talk: GLGETSAMPLERPARAMETE(3G) is the manual page for glGetSamplerParameter, and it's literally the "hey what did I set this sampler to again?" function. let's get into it ✨

✨ NAME ✨

glGetSamplerParameter — return sampler parameter values 🎀

🫶 C SPECIFICATION 🫶

void glGetSamplerParameterfv(GLuint sampler, GLenum pname,
                             GLfloat * params);

void glGetSamplerParameteriv(GLuint sampler, GLenum pname,
                             GLint * params);

void glGetSamplerParameterIiv(GLuint sampler, GLenum pname,
                              GLint * params);

void glGetSamplerParameterIuiv(GLuint sampler, GLenum pname,
                               GLuint * params);

like, pick your flavor: f for floats, i for ints, Ii for signed-integer-pretending-to-be-float vibes, Iui for the unsigned girlies. 👑

💖 PARAMETERS 💖

  • sampler — the name of the sampler object you're pulling the parameters out of. like, which sampler bestie are we interrogating rn 🔍
  • pname — the symbolic name of the sampler parameter you want. accepted values are GL_TEXTURE_MAG_FILTER, GL_TEXTURE_MIN_FILTER, GL_TEXTURE_MIN_LOD, GL_TEXTURE_MAX_LOD, GL_TEXTURE_LOD_BIAS, GL_TEXTURE_WRAP_S, GL_TEXTURE_WRAP_T, GL_TEXTURE_WRAP_R, GL_TEXTURE_BORDER_COLOR, GL_TEXTURE_COMPARE_MODE, and GL_TEXTURE_COMPARE_FUNC. that's the whole menu, no substitutions 🍓
  • params — where the returned sampler parameters go. it's giving output buffer, main character energy ✨

🌸 DESCRIPTION 🌸

glGetSamplerParameter returns, in params, the value or values of the sampler parameter you named as pname. sampler is the target sampler and it must be the name of an existing sampler object — specifically one returned from a previous call to glGenSamplers(). no inventing sampler names, that's not the vibe 🙈

pname accepts the exact same symbols as glSamplerParameter(), with the exact same interpretations:

GL_TEXTURE_MAG_FILTER — returns the single-valued texture magnification filter, a symbolic constant. the initial value is GL_LINEAR.

GL_TEXTURE_MIN_FILTER — returns the single-valued texture minification filter, a symbolic constant. the initial value is GL_NEAREST_MIPMAP_LINEAR.

GL_TEXTURE_MIN_LOD — returns the single-valued texture minimum level-of-detail value. the initial value is -1000.

GL_TEXTURE_MAX_LOD — returns the single-valued texture maximum level-of-detail value. the initial value is 1000.

GL_TEXTURE_WRAP_S — returns the single-valued wrapping function for texture coordinate s, a symbolic constant. the initial value is GL_REPEAT.

GL_TEXTURE_WRAP_T — returns the single-valued wrapping function for texture coordinate t, a symbolic constant. the initial value is GL_REPEAT.

GL_TEXTURE_WRAP_R — returns the single-valued wrapping function for texture coordinate r, a symbolic constant. the initial value is GL_REPEAT.

GL_TEXTURE_BORDER_COLOR — returns four integer or floating-point numbers that comprise the RGBA color of the texture border. floating-point values come back in the range 0 to 1. integer values come back as a linear mapping of the internal floating-point representation, such that 1.0 maps to the most positive representable integer and -1.0 maps to the most negative representable integer. the initial value is (0, 0, 0, 0).

GL_TEXTURE_COMPARE_MODE — returns a single-valued texture comparison mode, a symbolic constant. the initial value is GL_NONE. see glSamplerParameter().

GL_TEXTURE_COMPARE_FUNC — returns a single-valued texture comparison function, a symbolic constant. the initial value is GL_LEQUAL. see glSamplerParameter().

🦋 NOTES 🦋

  • if an error is generated, no change is made to the contents of params. so like, don't go reading your buffer expecting fresh data if it errored, that's on you 😭
  • glGetSamplerParameter is available only if the GL version is 3.3 or higher. lowkey rude to the old-school girlies but okay 💀

💜 ERRORS 💜

  • GL_INVALID_VALUE is generated if sampler is not the name of a sampler object returned from a previous call to glGenSamplers(). (fake sampler name detected, blocked 🚫)
  • GL_INVALID_ENUM is generated if pname is not an accepted value. (not on the list, not getting in ✋)

🌈 VERSION SUPPORT 🌈

the original ships this as a big table, and since we're not doing tables here, lemme translate the whole thing for you — every OpenGL version is accounted for, no cap:

Columns, left to right: 2.0, 2.1, 3.0, 3.1, 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5.

  • glGetSamplerParameterIiv — 2.0: -, 2.1: -, 3.0: -, 3.1: -, 3.2: ✔, 3.3: ✔, 4.0: ✔, 4.1: ✔, 4.2: ✔, 4.3: ✔, 4.4: ✔, 4.5: ✔
  • glGetSamplerParameterIuiv — 2.0: -, 2.1: -, 3.0: -, 3.1: -, 3.2: ✔, 3.3: ✔, 4.0: ✔, 4.1: ✔, 4.2: ✔, 4.3: ✔, 4.4: ✔, 4.5: ✔
  • glGetSamplerParameterfv — 2.0: -, 2.1: -, 3.0: -, 3.1: -, 3.2: ✔, 3.3: ✔, 4.0: ✔, 4.1: ✔, 4.2: ✔, 4.3: ✔, 4.4: ✔, 4.5: ✔
  • glGetSamplerParameteriv — 2.0: -, 2.1: -, 3.0: -, 3.1: -, 3.2: ✔, 3.3: ✔, 4.0: ✔, 4.1: ✔, 4.2: ✔, 4.3: ✔, 4.4: ✔, 4.5: ✔

like, all four showed up at 3.2 together and never left. iconic synchronized entrance 💅

🧚 SEE ALSO 🧚

  • glSamplerParameter()
  • glGenSamplers()
  • glDeleteSamplers()
  • glSamplerParameter()

(yes, glSamplerParameter() is listed twice in the original. i'm not fixing it, i'm just reporting it. that's her brand 🎀)

Copyright © 2010-2014 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. http://opencontent.org/openpub/.

Copyright © 2010-2014 Khronos Group

okay that's the whole page, mwah 💋 — sign-off time: the source field says [FIXME: source] (still unfilled, we love an unfinished metadata moment 🫠) and the date on this beauty is 08/09/2021. go forth and query your samplers, bestie 🌟

📦 where this page comes from