This allocates space in the ofImage, both the ofPixels and the ofTexture that the ofImage contains.

You don't need to call this before loading an image, but for when you want to allocate. space ahead of when you are going to use the image.

The types of images can be OF_IMAGE_COLOR, OF_IMAGE_COLOR_ALPHA or OF_IMAGE_GRAYSCALE.

You need to call update() to update the texture after updating the pixels manually.

Parameters

w	Width of image to allocate.
h	Height of image to allocate.
type	The ofImageType.

Whether the image has been allocated either by a call to allocate or by loading pixel data into the image.

Returns

true if the image has been allocated.

Whether the image has been allocated either by a call to allocate or by loading pixel data into the image.

This clears the texture and pixels contained within the ofImage.

Create an ofImage from another ofImage instance.

This allows you to create an ofImage from another ofImage instance, copying all the pixels and the texture data while creating a new textureID.

Loads an image given by fileName.

Parameters

fileName

Program looks for image given by fileName, relative to the data folder.

Returns

true if image loaded correctly.

Loads an image from an ofBuffer instance created by, for instance, ofFile::readToBuffer().

This actually loads the image data into an ofPixels object and then into the texture.

Loads an image from an ofFile instance created by, for instance, ofDirectory::getFiles().

This actually loads the image data into an ofPixels object and then into the texture.

Draw the image at it's normal size.

Parameters

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

Implements ofBaseDraws.

Draw the texture at it's normal size with depth.

Parameters

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

Draw the image at a given 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 image at a given size with 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 a subsection of the image.

This functions like a clipping mask. Does not altering any pixel data.

Parameters

x	X position to draw cropped image at.
y	Y position to draw cropped image at.
w	Width of subsection to draw.
h	Height of subsection to draw.
sx	X position in image to begin cropping from.
sy	Y position in image to begin cropping from.

Draws a subsection of the image.

This functions like a clipping mask. Does not altering any pixel data.

Parameters

x	X position to draw cropped image at.
y	Y position to draw cropped image at.
z	Z position to draw cropped image at.
w	Width of subsection to draw.
h	Height of subsection to draw.
sx	X position in image to begin cropping from.
sy	Y position in image to begin cropping from.

Draws a subsection of the image.

This functions like a clipping mask. Does not altering any pixel data.

Parameters

x	X position to draw cropped image at.
y	Y position to draw cropped image at.
w	Width of subsection to draw.
h	Height of subsection to draw.
sx	X position in image to begin cropping from.
sy	Y position in image to begin cropping from.
sw	Source width of cropped area.
sh	Source height of cropped area.

Draws a subsection of the image.

This functions like a clipping mask. Does not altering any pixel data.

Parameters

x	X position to draw cropped image at.
y	Y position to draw cropped image at.
z	Z position to draw cropped image at.
w	Width of subsection to draw.
h	Height of subsection to draw.
sx	X position in image to begin cropping from.
sy	Y position in image to begin cropping from.
sw	Source width of cropped area.
sh	Source height of cropped area.

Call to ensure that changes to pixels are reflected in the ofTexture of the image.

Many of the ofImage methods call this after they change the pixels, but if you directly manipulate the pixels of the ofImage, then you should make sure to call update() before trying to draw the texture of the image to the screen.

Turns on or off the allocation and use of a texture.

Parameters

bUse	Allocate and use a texture or not.

Implements ofBaseHasTexture.

Returns whether the ofImage has a texture or not.

If the ofImage doesn't have a texture, nothing will be drawn to the screen.

Returns

Returns whether the ofImage has a texture or not.

Implements ofBaseHasTexture.

Returns the texture that the ofImage contains.

You can use this to directly manipulate the texture itself, but keep in mind that if you manipulate the texture directly, there is no simple way to copy the data from the texture back to the pixels and keep the ofImage in sync.

Returns

Returns the texture that the ofImage contains.

Implements ofBaseHasTexture.

Returns

a const reference to the ofTexture.

Implements ofBaseHasTexture.

Binds the oftexture instance that the ofImage contains so that it can be used for advanced drawing.

Unbinds the ofTexture instance that the ofImage contains.

Call this after you call bind().

This sets the compression level used when creating mipmaps for the ofTexture contained by the ofImage.

Parameters

compression

The ofTexCompression to set.

Returns a raw pointer to the pixel data.

This function will give you access to a continuous block of pixels. you can grab the data and do what you like with it. If you have a grayscale image, you will have (width*height) number of pixels. Color images will have (width*height*3) number of pixels (interlaced R,G,B), and coloralpha images will have (width*height*4) number of pixels (interlaced R,G,B,A).

Warning

This is a raw pointer. It's up to you to get this right.

Returns

A raw pointer to the pixel data.

Implements ofBaseHasPixels_< PixelType >.

Get a const reference to the underlying ofPixels.

Returns

a const reference the underlying ofPixels.

Implements ofBaseHasPixels_< PixelType >.

This returns an ofPixels reference that you can use to manipulate the raw pixel data of the ofImage.

Make sure you call either update() after making changes to the ofPixels.

Returns

An ofPixels reference that you can use to manipulate the raw pixel data of the ofImage.

This returns the ofColor representing the pixels at the x and y position passed in.

Parameters

x	x position of pixel
y	y position of pixel

Returns

The ofColor representing the pixels at the x and y position passed in.

Get height of image as a float.

Returns

Height of image as float.

Implements ofBaseDraws.

Get width of image as a float.

Returns

Width of image as float.

Implements ofBaseDraws.

Sets the pixel at the x,y position passed in.

The ofColor type needs to match the ofImage type, i.e. ofFloatImage requires that you use ofFloatPixels.

Parameters

x	x position of pixel.
y	y position of pixel.
color	Color to set pixel to.

Sets the pixel at the given pixel buffer index.

Parameters

index	Index of pixel to set.
color	Color to set pixel to.

Sets all pixels to a color.

Parameters

color

Color to set pixel to.

Sets the pixels of the image from an array of values.

Set the pixels of the image from an array of values, for an ofFloatImage these need to be floats, for an ofImage these need to be unsigned chars. The w and h values are important so that the correct dimensions are set in the image. This assumes that you're setting the pixels from 0,0 or the upper left hand corner of the image. The bOrderIsRGB flag allows you pass in pixel data that is BGR by setting bOrderIsRGB=false.

Parameters

pixels	Array of pixel values.
w	Width of image being passed in.
h	Height of image being passed in.
type	The image type can be OF_IMAGE_GRAYSCALE, OF_IMAGE_COLOR, or OF_IMAGE_COLOR_ALPHA.
bOrderIsRGB	Pass in pixel data that is BGR by setting bOrderIsRGB=false.

Set the pixels of the image from an ofPixels instance.

Set the pixels of the image from an ofPixels instance, for an ofFloatImage these need to be ofFloatPixels, for an ofImage these need to be unsigned chars.

Grabs pixels from the opengl window specified by the region (x, y, w, h) and turns them into an image.

It resizes or allocates the ofImage if it's necessary.

Warning

Uses glReadPixels() which can be slow.

Parameters

x	x position of upper-left corner of region.
y	y position of upper-left corner of region.
w	Width of region.
h	Height of region.

Set type of image to one of the following: OF_IMAGE_GRAYSCALE, OF_IMAGE_COLOR, OF_IMAGE_COLOR_ALPHA.

This does cause the image to be reallocated and the texture to be updated, so it can be an expensive operation if done frequently. Converting down, for example from color to grayscale, loses information and is a destructive change.

Parameters

type	The type of image, one of the following: OF_IMAGE_GRAYSCALE, OF_IMAGE_COLOR, OF_IMAGE_COLOR_ALPHA

Resizes the image to a new size (w, h); Can be used to scale up or down an image.

Parameters

newWidth	New width of image.
newHeight	New height of image.

This crops the image to the w,h passed in from the x,y position.

This does an in place crop and allocates memory.

Parameters

x	x position of upper-left corner of region to crop.
y	y position of upper-left corner of region to crop.
w	Width of region to crop.
h	Height of region to crop.

Replaces region in caller image specified by w,h,x,y with pixels from otherImage.

The w,h are measured from the x,y, so passing 100, 100, 300, 300 will grab a 300x300 pixel block of data starting from 100, 100.

Parameters

otherImage	Image to crop from.
x	x position of upper-left corner of region to crop.
y	y position of upper-left corner of region to crop.
w	Width of region to crop.
h	Height of region to crop.

Rotates the image by a multiple of 90 degrees.

Parameters

rotation

Amount to rotate in multiples of 90. For instance, if you pass in 2, then the image will be rotated 180 degrees.

This reflects the pixels of the image across the vertical and/or horizontal axis.

Parameters

vertical	Set to true to reflect image across vertical axis.
horizontal	Set to true to reflect image across horizontal axis.

Change the drawing anchor from top-left corner to a position specified by xPct and yPct.

Changes the drawing position specified by draw() from the normal top- left corner of the image to a position specified by xPct and yPct in relation to the dimensions of the image. This can be useful for aligning and centering images as well as rotating an image around its center. Note: range of xPct and yPct is 0.0 to 1.0. For xPct, 1.0 represents the width of the image. For yPct, 1.0 represents the height of the image. These values are not capped.

Parameters

xPct	X position of the new anchor, specified as a percent of the width of the image.
yPct	Y position of the new anchor, specified as a percent of the height of the image.

Reimplemented from ofBaseDraws.

Changes drawing position from top-left corner to position specified by x,y.

Changes the drawing position specified by draw() from the normal top- left corner of the image to a position specified by x and y, measured in pixels. This can be useful for aligning and centering images as well as rotating an image around its center.

Parameters

x	X position of the new anchor.
y	Y position of the new anchor.

Reimplemented from ofBaseDraws.

Removes anchor positioning.

Resets the anchor to (0, 0) so the image will be drawn from its upper left hand corner.

Reimplemented from ofBaseDraws.

Saves the image to the file path in fileName with the image quality specified by compressionLevel.

Parameters

fileName	Saves image to this path, relative to the data folder.
compressionLevel	The ofImageQualityType.

This saves the image to the ofBuffer passed with the image quality specified by compressionLevel.

Parameters

buffer	ofBuffer to save image to.
compressionLevel	The ofImageQualityType.

This saves the image to the ofFile passed with the image quality specified by compressionLevel.

Parameters

file	ofFile to save image to.
compressionLevel	The different compression levels are: OF_IMAGE_QUALITY_BEST, OF_IMAGE_QUALITY_HIGH, OF_IMAGE_QUALITY_MEDIUM, OF_IMAGE_QUALITY_LOW, OF_IMAGE_QUALITY_WORST

Image width in pixels.

Image Height in pixels.

Bits per image pixel.

Image type.

See Also

ofImageType

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.