Format /

#include “cinder/gl/Texture.h”

Public Member Functions
Protected Attributes

Class Hierarchy:

cinder::gl::TextureBase::Format
cinder::gl::Texture2d::Format

Public Member Functions

Format ()

Default constructor, sets the target to GL_TEXTURE_2D , wrap to GL_CLAMP , disables mipmapping, the internal format to "automatic".
Format &

target (GLenum target)

Chaining functions for Format class.
Format &

mipmap (bool enableMipmapping=true)
Format &

maxAnisotropy (float maxAnisotropy)

Sets the maximum amount of anisotropic filtering. A value greater than 1.0 "enables" anisotropic filtering. Maximum of getMaxAnisotropyMax() ;.
Format &

internalFormat (GLint internalFormat)

Specifies the internal format for the Texture, used by glTexImage2D or glTexStorage2D when available. Defaults to -1 which implies automatic determination.
Format &

dataType (GLint dataType)

Specifies the data type parameter used by glTexImage2D when glTexStorage2D is unavailable. Defaults to -1 which implies automatic determination. Primary use is to pass GL_FLOAT or GL_HALF_FLOAT to create 32F or 16F textures on ES 2 when OES_texture_float is available.
Format &

wrap (GLenum wrap)
Format &

wrapS (GLenum wrapS)
Format &

wrapT (GLenum wrapT)
Format &

wrapR (GLenum wrapR)
Format &

minFilter (GLenum minFilter)
Format &

magFilter (GLenum magFilter)
Format &

compareMode (GLenum compareMode)
Format &

compareFunc (GLenum compareFunc)

Specifies the comparison operator used when GL_TEXTURE_COMPARE_MODE is set to GL_COMPARE_R_TO_TEXTURE .
Format &

swizzleMask (const std::array< GLint, 4 > &swizzleMask)
Format &

swizzleMask (GLint r, GLint g, GLint b, GLint a)
Format &

loadTopDown (bool loadTopDown=true)

Specifies whether the Texture should store scanlines top-down in memory. Default is false . Also marks Texture as top-down when true .
Format &

immutableStorage (bool immutable=true)

Sets whether the storage for the cannot be changed in the future (making glTexImage2D() calls illegal). More efficient when possible. Default is false .
Format &

intermediatePbo (const PboRef &intermediatePbo)
Format &

label (const std::string &label)

Sets the debugging label associated with the Texture. Calls glObjectLabel() when available.
Format &

deleter (const std::function< void(Texture2d *)> &sharedPtrDeleter)

Sets a custom deleter for destruction of the shared_ptr<Texture2d>
Format &

perGpuStorageNV (bool enable=true)

(NVIDIA only) Enables per-gpu storage for multi-gpu multicast.
void

setTarget (GLenum target)

Specifies the texture's target. The default is GL_TEXTURE_2D .
void

setTargetRect ()

Sets the texture's target to be GL_TEXTURE_RECTANGLE . Not available in OpenGL ES.
void

enableMipmapping (bool enableMipmapping=true)

Enables or disables mipmapping. Default is disabled.
void

setBaseMipmapLevel (GLuint level)

Specifies the index of the lowest defined mipmap level. Default is 0 . Ignored on ES 2.
void

setMaxMipmapLevel (GLint level)

Sets the max mipmap level. Default (expressed as -1 ) is derived from the size of the texture. Ignored on ES 2.
GLuint

getBaseMipmapLevel () const

Returns the index of the lowest defined mipmap level.
GLuint

getMaxMipmapLevel () const

Returns the max mipmap level.
void

setImmutableStorage (bool immutable=true)

Sets whether the storage for the cannot be changed in the future (making glTexImage*D() calls illegal). More efficient when possible. Default is false .
bool

isImmutableStorage () const

Returns whether the storage for the cannot be changed in the future (making glTexImage*D() calls illegal). Default is false .
void

setInternalFormat (GLint internalFormat)

Sets the Texture's internal format. A value of -1 implies selecting the best format for the context.
void

setAutoInternalFormat ()

Sets the Texture's internal format to be automatically selected based on the context.
void

setDataType (GLint dataType)

Sets the data type parameter used by glTexImage2D when glTexStorage2D is unavailable. Defaults to -1 which implies automatic determination. Primary use is to pass GL_FLOAT or GL_HALF_FLOAT to create 32F or 16F textures on ES 2 when OES_texture_float is available.
void

setAutoDataType ()

Sets the Texture's data type format to be automatically selected based on the context.
void

setCompareMode (GLenum compareMode)
void

setCompareFunc (GLenum compareFunc)
GLenum

getCompareMode () const

Returns the texture comparison mode for currently bound depth texture.
GLenum

getCompareFunc () const

Returns the comparison operator used when GL_TEXTURE_COMPARE_MODE is set to GL_COMPARE_R_TO_TEXTURE .
void

setWrap (GLenum wrapS, GLenum wrapT)

Sets the wrapping behavior when a texture coordinate falls outside the range of [0,1]. Possible values are GL_REPEAT , GL_CLAMP_TO_EDGE , etc. Default is GL_CLAMP_TO_EDGE .
void

setWrap (GLenum wrapS, GLenum wrapT, GLenum wrapR)

Sets the wrapping behavior when a texture coordinate falls outside the range of [0,1]. Possible values are GL_REPEAT , GL_CLAMP_TO_EDGE , etc. Default is GL_CLAMP_TO_EDGE .
void

setWrapS (GLenum wrapS)

Sets the horizontal wrapping behavior when a texture coordinate falls outside the range of [0,1]. Possible values are GL_REPEAT , GL_CLAMP_TO_EDGE , etc. Default is GL_CLAMP_TO_EDGE .
void

setWrapT (GLenum wrapT)

Sets the vertical wrapping behavior when a texture coordinate falls outside the range of [0,1]. Possible values are GL_REPEAT , GL_CLAMP_TO_EDGE , etc. Default is GL_CLAMP_TO_EDGE .
void

setWrapR (GLenum wrapR)

Sets the depth wrapping behavior when a texture coordinate falls outside the range of [0,1]. Possible values are GL_REPEAT , GL_CLAMP_TO_EDGE , etc. Default is GL_CLAMP_TO_EDGE .
void

setMinFilter (GLenum minFilter)

Sets the filtering behavior when a texture is displayed at a lower resolution than its native resolution. Default is GL_LINEAR unless mipmapping is enabled, in which case GL_LINEAR_MIPMAP_LINEAR .
void

setMagFilter (GLenum magFilter)

Sets the filtering behavior when a texture is displayed at a higher resolution than its native resolution. Default is GL_LINEAR .
void

setMaxAnisotropy (GLfloat maxAnisotropy)

Sets the anisotropic filter amount. A value greater than 1.0 "enables" anisotropic filtering. Maximum of getMaxAnisotropyMax() ;.
GLenum

getTarget () const

Returns the texture's target.
bool

hasMipmapping () const

Returns whether the texture has mipmapping enabled.
GLint

getInternalFormat () const

Returns the Texture's internal format. A value of -1 implies automatic selection of the internal format based on the context.
bool

isAutoInternalFormat () const

Returns whether the Texture's internal format will be automatically selected based on the context.
GLint

getDataType () const

Returns the data type parameter used by glTexImage2D when glTexStorage2D is unavailable. Defaults to -1 which implies automatic determination.
bool

isAutoDataType () const

Returns whether the Texture's data type will be automatically selected based on the context.
GLenum

getWrapS () const

Returns the horizontal wrapping behavior for the texture coordinates.
GLenum

getWrapT () const

Returns the vertical wrapping behavior for the texture coordinates.
GLenum

getWrapR () const

Returns the depth wrapping behavior for the texture coordinates.
GLenum

getMinFilter () const

Returns the texture minifying function, which is used whenever the pixel being textured maps to an area greater than one texture element.
GLenum

getMagFilter () const

Returns the texture magnifying function, which is used whenever the pixel being textured maps to an area less than or equal to one texture element.
GLfloat

getMaxAnisotropy () const

Returns the texture anisotropic filtering amount.
void

setIntermediatePbo (const PboRef &intermediatePbo)

Supplies an intermediate PBO that Texture constructors optionally make use of. A PBO of an inadequate size may result in an exception.
const PboRef &

getIntermediatePbo () const

Returns the optional intermediate PBO that Texture constructors may make use of.
void

setBorderColor (const std::array< GLfloat, 4 > &border)

Sets the texture's border color. Ignored in OpenGL ES.
void

setBorderColor (const ColorA &color)

Sets the texture's border color. Ignored in OpenGL ES.
void

setSwizzleMask (const std::array< GLint, 4 > &swizzleMask)

Sets the swizzle mask corresponding to GL_TEXTURE_SWIZZLE_RGBA . Expects GL_RED through GL_ALPHA , or GL_ONE or GL_ZERO .
void

setSwizzleMask (GLint r, GLint g, GLint b, GLint a)

Sets the swizzle mask corresponding to GL_TEXTURE_SWIZZLE_RGBA . Expects GL_RED through GL_ALPHA , or GL_ONE or GL_ZERO .
const std::array< GLint, 4 > &

getSwizzleMask () const

Returns the swizzle mask corresponding to GL_TEXTURE_SWIZZLE_RGBA .
const std::string &

getLabel () const

Returns the debugging label associated with the Texture.
void

setLabel (const std::string &label)

Sets the debugging label associated with the Texture. Calls glObjectLabel() when available.
bool

isPerGpuStorageNV () const

(NVIDIA only) Returns whether per-gpu storage is enabled.
void

setPerGpuStorageNV (bool enable)

(NVIDIA only) Enables per-gpu storage for multi-gpu multicast.

Protected Attributes

bool

mLoadTopDown
std::function< void(Texture2d *)>

mDeleter
friend

Texture2d
GLenum

mTarget
GLenum

mWrapS
GLenum

mWrapT
GLenum

mWrapR
GLenum

mMinFilter
GLenum

mMagFilter
GLint

mCompareMode
GLint

mCompareFunc
bool

mMipmapping
bool

mMipmappingSpecified
bool

mMinFilterSpecified
GLuint

mBaseMipmapLevel
GLint

mMaxMipmapLevel
bool

mImmutableStorage
GLfloat

mMaxAnisotropy
GLint

mInternalFormat
GLint

mDataType
bool

mSwizzleSpecified
std::array< GLint, 4 >

mSwizzleMask
bool

mBorderSpecified
std::array< GLfloat, 4 >

mBorderColor
std::string

mLabel
bool

mPerGpuStorageSpecifiedNV
bool

mPerGpuStorageEnabledNV
PboRef

mIntermediatePbo

Namespaces

Classes

Modules

Guides

Reference

Format /

Public Member Functions

Protected Attributes