#include <juce_Image.h>
Classes | |
| class | BitmapData |
Public Types | |
| enum | PixelFormat { UnknownFormat , RGB , ARGB , SingleChannel } |
Private Attributes | |
| ReferenceCountedObjectPtr< ImagePixelData > | image |
Detailed Description
Holds a fixed-size bitmap.
The image is stored in either 24-bit RGB or 32-bit premultiplied-ARGB format.
To draw into an image, create a Graphics object for it. e.g.
Other useful ways to create an image are with the ImageCache class, or the ImageFileFormat, which provides a way to load common image files.
- See also
- Graphics, ImageFileFormat, ImageCache, ImageConvolutionKernel
@tags{Graphics}
Member Enumeration Documentation
◆ PixelFormat
| enum juce::Image::PixelFormat |
Constructor & Destructor Documentation
◆ Image() [1/6]
|
noexcept |
Creates a null image.
◆ Image() [2/6]
| juce::Image::Image | ( | PixelFormat | format, |
| int | imageWidth, | ||
| int | imageHeight, | ||
| bool | clearImage ) |
Creates an image with a specified size and format.
The image's internal type will be of the NativeImageType class - to specify a different type, use the other constructor, which takes an ImageType to use.
- Parameters
-
format the preferred pixel format. Note that this is only a hint which is passed to the ImageType class - different ImageTypes may not support all formats, so may substitute e.g. ARGB for RGB. imageWidth the desired width of the image, in pixels - this value must be greater than zero (otherwise a width of 1 will be used) imageHeight the desired width of the image, in pixels - this value must be greater than zero (otherwise a height of 1 will be used) clearImage if true, the image will initially be cleared to black (if it's RGB) or transparent black (if it's ARGB). If false, the image may contain junk initially, so you need to make sure you overwrite it thoroughly.
◆ Image() [3/6]
| juce::Image::Image | ( | PixelFormat | format, |
| int | imageWidth, | ||
| int | imageHeight, | ||
| bool | clearImage, | ||
| const ImageType & | type ) |
Creates an image with a specified size and format.
- Parameters
-
format the preferred pixel format. Note that this is only a hint which is passed to the ImageType class - different ImageTypes may not support all formats, so may substitute e.g. ARGB for RGB. imageWidth the desired width of the image, in pixels - this value must be greater than zero (otherwise a width of 1 will be used) imageHeight the desired width of the image, in pixels - this value must be greater than zero (otherwise a height of 1 will be used) clearImage if true, the image will initially be cleared to black (if it's RGB) or transparent black (if it's ARGB). If false, the image may contain junk initially, so you need to make sure you overwrite it thoroughly. type the type of image - this lets you specify the internal format that will be used to allocate and manage the image data.
◆ Image() [4/6]
|
noexcept |
◆ Image() [5/6]
|
noexcept |
Move constructor
◆ ~Image()
| juce::Image::~Image | ( | ) |
Destructor.
◆ Image() [6/6]
|
explicitnoexcept |
Member Function Documentation
◆ clear()
| void juce::Image::clear | ( | const Rectangle< int > & | area, |
| Colour | colourToClearTo = Colour (0x00000000) ) |
Clears a section of the image with a given colour.
This won't do any alpha-blending - it just sets all pixels in the image to the given colour (which may be non-opaque if the image has an alpha channel).
◆ convertedToFormat()
| Image juce::Image::convertedToFormat | ( | PixelFormat | newFormat | ) | const |
Returns a version of this image with a different image format.
A new image is returned which has been converted to the specified format.
Note that if the new format is no different to the current one, this will just return a reference to the original image, and won't actually create a copy.
◆ createCopy()
| Image juce::Image::createCopy | ( | ) | const |
Creates a copy of this image. Note that it's usually more efficient to use duplicateIfShared(), because it may not be necessary to copy an image if nothing else is using it.
- See also
- getReferenceCount
◆ createLowLevelContext()
| std::unique_ptr< LowLevelGraphicsContext > juce::Image::createLowLevelContext | ( | ) | const |
Creates a context suitable for drawing onto this image. Don't call this method directly! It's used internally by the Graphics class.
◆ createSolidAreaMask()
| void juce::Image::createSolidAreaMask | ( | RectangleList< int > & | result, |
| float | alphaThreshold ) const |
Creates a RectangleList containing rectangles for all non-transparent pixels of the image.
- Parameters
-
result the list that will have the area added to it alphaThreshold for a semi-transparent image, any pixels whose alpha is above this level will be considered opaque
◆ desaturate()
| void juce::Image::desaturate | ( | ) |
Changes all the colours to be shades of grey, based on their current luminosity.
◆ duplicateIfShared()
| void juce::Image::duplicateIfShared | ( | ) |
Makes sure that no other Image objects share the same underlying data as this one.
If no other Image objects refer to the same shared data as this one, this method has no effect. But if there are other references to the data, this will create a new copy of the data internally.
Call this if you want to draw onto the image, but want to make sure that this doesn't affect any other code that may be sharing the same data.
- See also
- getReferenceCount
◆ getBounds()
Returns a rectangle with the same size as this image. The rectangle's origin is always (0, 0).
◆ getClippedImage()
Returns an image which refers to a subsection of this image.
This will not make a copy of the original - the new image will keep a reference to it, so that if the original image is changed, the contents of the subsection will also change. Likewise if you draw into the subimage, you'll also be drawing onto that area of the original image. Note that if you use operator= to make the original Image object refer to something else, the subsection image won't pick up this change, it'll remain pointing at the original.
The area passed-in will be clipped to the bounds of this image, so this may return a smaller image than the area you asked for, or even a null image if the area was out-of-bounds.
◆ getFormat()
|
noexcept |
Returns the image's pixel format.
◆ getHeight()
|
noexcept |
Returns the image's height (in pixels).
◆ getPixelAt()
Returns the colour of one of the pixels in the image.
If the coordinates given are beyond the image's boundaries, this will return Colours::transparentBlack.
- See also
- setPixelAt, Image::BitmapData::getPixelColour
◆ getPixelData()
|
inlinenoexcept |
◆ getProperties()
| NamedValueSet * juce::Image::getProperties | ( | ) | const |
Returns a NamedValueSet that is attached to the image and which can be used for associating custom values with it.
If this is a null image, this will return a null pointer.
◆ getReferenceCount()
|
noexcept |
Returns the number of Image objects which are currently referring to the same internal shared image data.
- See also
- duplicateIfShared
◆ getWidth()
|
noexcept |
Returns the image's width (in pixels).
◆ hasAlphaChannel()
|
noexcept |
True if the image contains an alpha-channel.
◆ isARGB()
|
noexcept |
True if the image's format is ARGB.
◆ isNull()
|
inlinenoexcept |
◆ isRGB()
|
noexcept |
True if the image's format is RGB.
◆ isSingleChannel()
|
noexcept |
True if the image's format is a single-channel alpha map.
◆ isValid()
|
inlinenoexcept |
◆ moveImageSection()
| void juce::Image::moveImageSection | ( | int | destX, |
| int | destY, | ||
| int | sourceX, | ||
| int | sourceY, | ||
| int | width, | ||
| int | height ) |
Copies a section of the image to somewhere else within itself.
◆ multiplyAllAlphas()
| void juce::Image::multiplyAllAlphas | ( | float | amountToMultiplyBy | ) |
Changes the overall opacity of the image.
This will multiply the alpha value of each pixel in the image by the given amount (limiting the resulting alpha values between 0 and 255). This allows you to make an image more or less transparent.
If the image doesn't have an alpha channel, this won't have any effect.
◆ multiplyAlphaAt()
Changes the opacity of a pixel.
This only has an effect if the image has an alpha channel and if the given coordinates are inside the image's boundary.
The multiplier must be in the range 0 to 1.0, and the current alpha at the given coordinates will be multiplied by this value.
- See also
- setPixelAt
◆ operator!=()
Returns true if the two images are not referring to the same internal, shared image.
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ operator==()
Returns true if the two images are referring to the same internal, shared image.
◆ rescaled()
| Image juce::Image::rescaled | ( | int | newWidth, |
| int | newHeight, | ||
| Graphics::ResamplingQuality | quality = Graphics::mediumResamplingQuality ) const |
Returns a rescaled version of this image.
A new image is returned which is a copy of this one, rescaled to the given size.
Note that if the new size is identical to the existing image, this will just return a reference to the original image, and won't actually create a duplicate.
◆ setPixelAt()
Sets the colour of one of the image's pixels.
If the coordinates are beyond the image's boundaries, then nothing will happen.
Note that this won't do any alpha-blending, it'll just replace the existing pixel with the given one. The colour's opacity will be ignored if this image doesn't have an alpha-channel.
- See also
- getPixelAt, Image::BitmapData::setPixelColour
Member Data Documentation
◆ image
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_graphics/images/juce_Image.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_graphics/images/juce_Image.cpp
Generated on for LMMS by
1.16.1