Check whether OF is using GL_TEXTURE_RECTANGLE rectangular or GL_TEXTURE_2D textures.

See Also

ofEnableArbTex()

Returns

true if using GL_TEXTURE_RECTANGLE textures, false if using GL_TEXTURE_2D textures.

Use GL_TEXTURE_RECTANGLE textures.

GL_TEXTURE_RECTANGLE textures are more intuitive since they allow pixel based coordinates and are enabled by default.

GL_TEXTURE_2D textures use normalised texture coordinates (a float value between 0 and 1 is used to express texture coordinates along width and height).

GL_TEXTURE_2D textures are more widely supported and allow advanced features such as mipmaps and texture compression.

See Also

ofDisableArbTex()

Warning

GL_TEXTURE_RECTANGLE is not available in OpenGL ES.

GL_TEXTURE_RECTANGLE does not support mipmaps.

Use GL_TEXTURE_2D textures.

GL_TEXTURE_2D is OpenGL's default way of handling textures and supports a wider range of core OpenGL features such as mipmaps.

See Also

ofEnableArbTex()

Check whether OF is using normalized or pixel texture coordinates.

See Also

ofEnableNormalizedTexCoords()

Returns

true if using normalized (0 - 1) texture coordinates.

Use normalized (0 - 1) texture coordinates.

By default, textures in OF work with pixel-based coordinates based on given content dimensions (images size, fbo size, etc). Normalized (0 - 1) coordinates are the traditional OpenGL default as they allow working with internal texture data without having to worry about specific dimensions of the content.

This overrides individual ofTexture wrap settings.

See Also

http://www.opengl.org/sdk/docs/man4/html/glTexParameter.xhtml

Use pixel-based texture coordinates.

See Also

ofEnableNormalizedTexCoords()

Set custom global texture wrapping.

By default, textures are clamped to their edges with GL_CLAMP_TO_EDGE. Setting a repeat mode like GL_REPEAT allows you to create tiled backgrounds with small textures.

This overrides individual ofTexture wrap settings.

See Also

ofTexture::setTextureWrap

http://www.opengl.org/sdk/docs/man4/html/glTexParameter.xhtml

Warning

Deprecated. Use member methods instead.

Parameters

wrapS	wrap parameter for texture coordinate s.
wrapT	wrap parameter for texture coordinate t.

Check whether OF is using custom global texture wrapping.

Warning

Deprecated. Use member methods instead.

See Also

ofSetTextureWrap()

Returns

true if OF is currently using custom global texture wrapping.

Removes global custom texture wrapping.

Restores individual ofTexture wrap settings.

Warning

Deprecated. Use member methods instead.

See Also

ofSetTextureWrap()

Set custom global texture minification/magnification scaling filters.

This setting allows global control over how OpenGL scales textures. It overrides individual ofTexture min & mag filter settings.

Warning

Deprecated. Use member methods instead.

See Also

ofTexture::setTextureMinMagFilter()

Parameters

minFilter	minifying filter for scaling a pixel to a smaller area.
magFilter	magnifying filter for scaling a pixel to a larger area.

Check whether OF is using custom global texture scaling filters.

Returns

true if OF is currently using custom texture scaling filters.

Warning

Deprecated. Use member methods instead.

Removes global custom texture wrapping.

Restores individual ofTexture min mag filter settings.

Warning

Deprecated. Use member methods instead.

Texture compression types.

Compression is only available through OpenGL for textures using GL_TEXTURE_2D, not GL_TEXTURE_RECTANGLE, also note that most compression algorithms work on blocks of 4x4 pixels, and therefore expect compressed textures to have multiple-of-four dimensions.

Enable the global texture "edge hack" to compensate for edge artifacts.

Adds a 2 pixel offset to avoid possible edge artifacts (typically a black or white border). This very slightly alters the image by scaling. This is enabled by default.

Disable global texture "edge hack".

See Also

ofEnableTextureEdgeHack()

Check whether OF is using the texture "edge hack".

See Also

ofEnableTextureEdgeHack()

Returns

true if OF is currently using the texture "edge hack".

Construct an ofTexture instance.

Construct an ofTexture from an existing ofTexture.

Parameters

mom	The ofTexture to copy. Reuses internal GL texture ID.

Allocate the texture using the given settings.

This is useful if you need manual control over loading a number of textures with the same settings. Make sure to set the texture data parameters first.

Parameters

textureData

The settings to use when allocating the ofTexture.

Allocate the texture using the given settings and custom format.

Parameters

textureData	The settings to use when allocating the ofTexture.
glFormat	GL texture format: GL_RGBA, GL_LUMINANCE, etc.
pixelType	GL pixel type: GL_UNSIGNED_BYTE, GL_FLOAT, etc.

Allocate texture of a given size and format.

The width (w) and height (h) do not necessarily need to be powers of 2, but they do need to be large enough to contain the data you will upload to the texture.

The internal data type glFormat describes how OpenGL will store this texture internally. For example, if you want a grayscale texture, you can use GL_LUMINANCE. You can upload what ever type of data you want (using loadData()) but internally, opengl will store the information as grayscale. Other types include: GL_RGB, GL_RGBA.

This method applies the currently set OF texture type and defaults to ARB rectangular textures if they are supported. (They are not supported on OpenGL ES).

Parameters

w	Desired width in pixels.
h	Desired height in pixels.
glInternalFormat	OpenGL internal data format: GL_RGBA, GL_LUMINANCE, etc.

Allocate texture of a given size and format.

See Also

allocate(int w, int h, int glInternalFormat)

Parameters

w	Desired width in pixels.
h	Desired height in pixels.
glInternalFormat
glFormat
pixelType	GL pixel type: GL_UNSIGNED_BYTE, GL_FLOAT, etc.

Allocate texture of a given size and format. Specify texture type.

This allows to enable the ARBE extension for this texture. This will overide the default OF texture type, in case you need a square texture (GL_TEXTURE_2D).

Warning

ARB textures are not available in OpenGL ES.

See Also

ofEnableArbTex()

allocate(int w, int h, int glInternalFormat)

Parameters

w	Desired width in pixels.
h	Desired height in pixels.
glInternalFormat
bUseARBExtension	Set to true to use rectangular textures.

Allocate texture of a given size, format, & type.

See Also

allocate(int w, int h, int glInternalFormat)

Parameters

w	Desired width in pixels.
h	Desired height in pixels.
glInternalFormat	OpenGL data format: GL_RGBA, GL_LUMINANCE, etc.
bUseARBExtension	Set to true to use rectangular textures.
glFormat	The OpenGL format.
pixelType	OpenGL pixel type: GL_UNSIGNED_BYTE, GL_FLOAT, etc.

Allocate texture using an ofPixels instance.

Pixel type and OpenGL format are determined from pixel settings.

Parameters

pix	Reference to ofPixels instance.

Allocate texture using an ofPixels instance and type.

This lets you overide the default OF texture type in case you need a square GL_TEXTURE_2D texture.

Warning

ARB textures are not available in OpenGL ES.

See Also

ofEnableArbTex()

allocate(const ofPixels& pix)

Parameters

pix	Reference to ofPixels instance.
bUseARBExtension	Set to true to use rectangular textures.

Allocate texture using an ofShortPixels instance.

Same as void allocate(const ofPixels& pix), except using ofShortPixels.

See Also

allocate(const ofPixels& pix)

Parameters

pix	Reference to ofShortPixels instance.

Allocate texture using an ofShortPixels instance and type.

Same as void void allocate(const ofPixels& pix), except using ofShortPixels.

See Also

allocate(const ofShortPixels& pix)

Parameters

pix	Reference to ofShortPixels instance.
bUseARBExtension	Set to true to use rectangular textures.

Allocate texture using an ofFloatPixels instance.

Same as void allocate(const ofPixels& pix), except using ofFloatPixels.

See Also

allocate(const ofPixels& pix)

Parameters

pix	Reference to ofFloatPixels instance.

Allocate texture using an ofShortPixels instance and type.

Same as void void allocate(const ofPixels& pix), except using ofShortPixels.

See Also

allocate(const ofFloatPixels& pix)

Parameters

pix	Reference to ofFloatPixels instance.
bUseARBExtension	Set to true to use rectangular textures.

Determine whether the texture has been allocated.

This lets you check if a texture is safe to draw. The texture can both be allocated by using allocate() or loading it with data loadData().

Returns

true if the texture has been allocated.

Has the texture been allocated?

Legacy function for backwards compatibility.

Returns

true if the texture has been allocated.

Destroy an ofTexture instance.

ofTexture keeps a reference count for the internal OpenGL texture ID. Thus, the texture ID is only released if there are no additional references to the internal texture ID.

Copy a given ofTexture into this texture.

Parameters

mom	The ofTexture to copy from. Reuses internal GL texture ID.

Clears the texture.

Clears / frees the texture memory, if something was already allocated. Useful if you need to control the memory on the graphics card.

The internal GL texture ID is only released if this is the last texture using it.

Set the texture ID.

Allows you to point the texture id to an externally allocated id (perhaps from another texture). It's up to you to set the rest of the textData parameters manually.

Warning

When setting an external texture ID, the user must set the remaining ofTextureData parameters manually.

Parameters

externTexID

New texture ID.

Load byte pixel data.

glFormat can be different to the internal format of the texture on each load, i.e. we can upload GL_BGRA pixels into a GL_RGBA texture but the number of channels need to match according to the OpenGL standard.

Parameters

data	Pointer to byte pixel data. Must not be NULL.
w	Pixel data width.
h	Pixel data height.
glFormat	GL pixel type: GL_RGBA, GL_LUMINANCE, etc.

Load short (2 byte) pixel data.

See Also

loadData(const unsigned char* const data, int w, int h, int glFormat)

Parameters

data	Pointer to byte pixel data. Must not be NULL.
w	Pixel data width.
h	Pixel data height.
glFormat	GL pixel type: GL_RGBA, GL_LUMINANCE, etc.

Load float pixel data.

See Also

loadData(const unsigned char* const data, int w, int h, int glFormat)

Parameters

data	Pointer to byte pixel data. Must not be NULL.
w	Pixel data width.
h	Pixel data height.
glFormat	GL pixel type: GL_RGBA, GL_LUMINANCE, etc.

Load pixels from an ofPixels instance.

Parameters

pix	Reference to ofPixels instance.

Load pixels from an ofShortPixels instance.

Same as loadData(ofPixels &) but for ofShortPixels.

See Also

loadData(const ofPixels & pix)

Parameters

pix	Reference to ofShortPixels instance.

Load pixels from an ofFloatPixels instance.

Same as loadData(ofPixels &) but for ofFloatPixels.

See Also

loadData(const ofPixels & pix)

Parameters

pix	Reference to ofFloatPixels instance.

Load pixels from an ofPixels instance and specify the format.

glFormat can be different to the internal format of the texture on each load, ie. we can upload GL_BGRA pixels into a GL_RGBA texture, but the number of channels need to match according to the OpenGL standard.

Parameters

pix	Reference to ofPixels instance.
glFormat	GL pixel type: GL_RGBA, GL_LUMINANCE, etc.

Load pixels from an ofShortPixels instance & specify the format.

See Also

loadData(const ofPixels & pix, int glFormat)

Parameters

pix	Reference to ofShortPixels instance.
glFormat	GL pixel type: GL_RGBA, GL_LUMINANCE, etc.

Load pixels from an ofFloatPixels instance and specify the format.

See Also

loadData(const ofPixels & pix, int glFormat)

Parameters

pix	Reference to ofFloatPixels instance.
glFormat	GL pixel type: GL_RGBA, GL_LUMINANCE, etc.

Load pixels from an ofBufferObject.

Parameters

buffer	The buffer to load.
glFormat	GL pixel type: GL_RGBA, GL_LUMINANCE, etc.
glType	the GL type to load.

Copy an area of the screen into this texture.

Specifiy the position (x,y) you wish to grab from, with the width (w) and height (h) of the region.

Make sure that you have allocated your texture (using allocate()) to be large enough to hold the region of the screen you wish to load.

See Also

http://www.opengl.org/sdk/docs/man4/html/glCopyTexSubImage2D.xhtml

Parameters

x	Upper left corner horizontal screen position.
y	Upper left corner vertical screen position.
w	Width of the area to copy in pixels.
h	Height of the area to copy in pixels.

Draw at a position at the native size.

Native size is determined by getWidth() and getHeight().

Parameters

x	Draw position on the x axis.
y	Draw position on the y axis.

Implements ofBaseDraws.

Draw at a position with the specified size.

Parameters

x	Draw position on the x axis.
y	Draw position on the y axis.
w	Draw width.
h	Draw height.

Implements ofBaseDraws.

Draw the texture at a given size witdh and depth.

Parameters

x	Draw position on the x axis.
y	Draw position on the y axis.
z	Draw position on the z axis.
w	Draw width.
h	Draw height.

Draws the texture at 4 points passed in as if you created 4 glVertices.

Parameters

p1	Upper left position on the x axis.
p2	Upper left position on the y axis.
p3	Lower right position on the x axis.
p4	Lower right position on the y axis.

ps: maybe if bUsingArbTex is enabled we should use glActiveTextureARB?

Draw a subsection of the texture.

Like ofRect() depend on the current OF_RECT_MODE:

• OF_RECT_MODE_CORNER: drawn with the upper left corner = (x,y)
• OF_RECT_MODE_CENTER: drawn centered on (x,y)

See Also

ofSetRectMode()

Parameters

x	Draw position on the x axis.
y	Draw position on the y axis.
w	Draw width.
h	Draw height.
sx	Subsection x axis offset within the texture.
sy	Subsection y axis offset within the texture.

Draw a subsection of the texture with depth.

See Also

drawSubsection(float x, float y, float w, float h, float sx, float sy)

Parameters

x	Draw position on the x axis.
y	Draw position on the y axis.
z	Draw position on the z axis.
w	Draw width.
h	Draw height.
sx	Subsection x axis offset within the texture.
sy	Subsection y axis offset within the texture.

Draw a subsection of the texture with an offset.

See Also

drawSubsection(float x, float y, float w, float h, float sx, float sy)

Parameters

x	Draw position on the x axis.
y	Draw position on the y axis.
w	Draw width.
h	Draw height.
sx	Subsection x axis offset within the texture.
sy	Subsection y axis offset within the texture.
sw	Subsection width within the texture.
sh	Subsection height within the texture.

Draw a subsection of the texture with an offset and depth.

See Also

drawSubsection(float x, float y, float w, float h, float sx, float sy)

Parameters

x	Draw position on the x axis.
y	Draw position on the y axis.
z	Draw position on the z axis.
w	Draw width.
h	Draw height.
sx	Subsection x axis offset within the texture.
sy	Subsection y axis offset within the texture.
sw	Subsection width within the texture.
sh	Subsection height within the texture.

Get a mesh that has the texture coordinates set.

See Also

drawSubsection(float x, float y, float w, float h, float sx, float sy)

Parameters

x	Draw position on the x axis.
y	Draw position on the y axis.
z	Draw position on the z axis.
w	Draw width.
h	Draw height.
sx	Subsection x axis offset within the texture.
sy	Subsection y axis offset within the texture.
sw	Subsection width within the texture.
sh	Subsection height within the texture.

Bind the texture.

For advanced users who need to manually manage texture drawing without calling ofTexture::draw.

See Also

http://www.opengl.org/sdk/docs/man4/html/glBindTexture.xhtml

Unbind the texture.

For advanced users who need to manually manage texture drawing without calling ofTexture::draw.

See Also

http://www.opengl.org/sdk/docs/man4/html/glBindTexture.xhtml

Calls glBindImageTexture on the texture

Binds the texture as an read or write image, only available since OpenGL 4.2

Warning

This is not available in OpenGLES

See Also

http://www.opengl.org/wiki/GLAPI/glBindImageTexture

Display height of texture.

Return value is pixel size (default) or normalized (0 - 1) if ofEnableNormalizedTextures() is set to true.

See Also

ofEnabledNormalizedTextures()

Returns

Display height of texture in pixels.

Implements ofBaseDraws.

Display width of texture.

Return value is pixel size (default) or normalized (0 - 1) if ofEnableNormalizedTextures() is set to true.

See Also

ofEnabledNormalizedTextures()

Returns

Display width of texture in pixels.

Implements ofBaseDraws.

Set the anchor point the texture is drawn around as a percentage.

This can be useful if you want to rotate an image around a particular point.

Parameters

xPct	Horizontal texture position as a percentage (0 - 1).
yPct	Vertical texture position as a percentage (0 - 1).

Reimplemented from ofBaseDraws.

Set the anchor point the texture is drawn around in pixels.

This can be useful if you want to rotate an image around a particular point.

Parameters

x	Horizontal texture position in pixels.
y	Vertical texture position in pixels.

Reimplemented from ofBaseDraws.

Reset the anchor point to (0, 0).

Reimplemented from ofBaseDraws.

Helper to convert display coordinate to texture coordinate.

Parameters

xPos	Horizontal position in pixels.
yPos	Vertical position in pixels.

Returns

Texture coordinate or ofPoint::zero() if texture is not allocated.

Helper to convert display coordinate to texture coordinate.

Parameters

xPts	Horizontal position in a normalized percentage (0 - 1).
yPts	Vertical position in a normalized percentage (0 - 1).

Returns

Texture coordinate or ofPoint::zero() if texture is not allocated.

Set another ofTexture to use as an alpha mask.

Parameters

mask	The texture to use as alpha mask.

Disable the alpha mask.

Set texture wrapping.

By default, textures are clamped to their edges with GL_CLAMP_TO_EDGE. Setting a repeat mode like GL_REPEAT allows you to create tiled backgrounds with small textures.

See Also

ofTextureSetWrap()

http://www.opengl.org/sdk/docs/man4/html/glTexParameter.xhtml

Warning

May be overridden.

Parameters

wrapModeHorizontal	wrap parameter for texture coordinate s.
wrapModeVertical	wrap parameter for texture coordinate t.

Set texture minification/magnification scaling filters.

Controls how OpenGL will scale this texture.

See Also

http://www.opengl.org/sdk/docs/man4/html/glTexParameter.xhtml

ofTextureSetMinMagFilters()

Warning

May be overridden.

Parameters

minFilter	minifying filter for scaling a pixel to a smaller area.
magFilter	magnifying filter for scaling a pixel to a larger area.

Sets a texture matrix to be uploaded whenever the texture is bound.

Parameters

m	The 4x4 texture matrix.

Sets a texture matrix that will be uploaded whenever the texture is binded.

Disable the texture matrix.

Disable the texture matrix.

Set the texture compression.

Warning

: not yet implemented.

See Also

ofTexCompression

Swizzle RGBA to grayscale with alpha in the red channel.

Use 1 channel GL_R as luminance instead of red channel in OpenGL 3+.

Warning

This is not supported in OpenGL ES and does nothing.

See Also

https://en.wikipedia.org/wiki/Swizzling_(computer_graphics)

Swizzle a channel to another.

Example:

will make channel 0 appear as alpha in the shader.

Warning

This is not supported in OpenGL ES and does nothing.

See Also

https://en.wikipedia.org/wiki/Swizzling_(computer_graphics)

Read current texture data from the GPU into pixels.

Warning

This is not supported in OpenGL ES and does nothing.

Parameters

pixels

Target ofPixels reference.

Read current texture data from the GPU into pixels.

Warning

This is not supported in OpenGL ES and does nothing.

Parameters

pixels

Target pixels reference.

Read current texture data from the GPU into pixels.

Warning

This is not supported in OpenGL ES and does nothing.

Parameters

pixels

Target pixels reference.

Copy the texture to an ofBufferObject.

Parameters

buffer

the target buffer to copy to.

Internal texture data access.

This returns the internal texture data for this texture, for instance, its textureID, type of texture, whether it's been allocated and other data about the state of the texture.

Returns

a reference to the internal texture data struct.

Const version of getTextureData().

See Also

ofTextureData::getTextureData()

Sets flag allowing texture to auto-generate a mipmap.

By default, this will set your minFilter to GL_LINEAR_MIPMAP_LINEAR. If you want to change your minFilter later use setTextureMinMagFilter()

If you want to generate a mipmap later, or at a specific point in your code, use generateMipmap() instead.

See Also

generateMipmap()

disableMipmap()

setTextureMinMagFilter()

Sets flag disallowing texture to auto-generate mipmap.

By default, this will set your minFilter to GL_LINEAR_MIPMAP_LINEAR. If you want to change your minFilter later use setTextureMinMagFilter()

If you want to generate a mipmap later, or at a specific point in your code, use ofTexture::generateMipmap() instead.

See Also

generateMipmap()

enableMipmap()

setTextureMinMagFilter()

Generate mipmap for the current texture.

Warning

Only GL_TEXTURE_RECTANGLE - which is the default openFrameworks texture target - does not support mipmaps, so make sure to call ofDisableArbTex() before loading texture data for a texture you want to generate mipmaps for.

See Also

ofEnableArbTex()

ofDisableArbTex()

OpenGL ES only supports mipmap for the following two texture targets:

OpenGL supports mipmaps for additional texture targets:

Draw at a position at the native size.

Native size is determined by getWidth() and getHeight().

Parameters

point

Draw position.

Draw at a position and size specified by a rectangle.

Parameters

rect	Draw position and size.

Draw at a position.

Parameters

point	Draw position.
w	Draw width.
h	Draw height.