juce::JPEGImageFormat Class Reference

#include <juce_ImageFileFormat.h>

Inheritance diagram for juce::JPEGImageFormat:

Public Member Functions
	JPEGImageFormat ()
	~JPEGImageFormat () override
void	setQuality (float newQuality)
String	getFormatName () override
bool	usesFileExtension (const File &) override
bool	canUnderstand (InputStream &) override
Image	decodeImage (InputStream &) override
bool	writeImageToStream (const Image &, OutputStream &) override
Public Member Functions inherited from juce::ImageFileFormat
virtual	~ImageFileFormat ()=default

Private Attributes
float	quality

Additional Inherited Members
Static Public Member Functions inherited from juce::ImageFileFormat
static ImageFileFormat *	findImageFormatForStream (InputStream &input)
static ImageFileFormat *	findImageFormatForFileExtension (const File &file)
static Image	loadFrom (InputStream &input)
static Image	loadFrom (const File &file)
static Image	loadFrom (const void *rawData, size_t numBytesOfData)
Protected Member Functions inherited from juce::ImageFileFormat
	ImageFileFormat ()=default

Detailed Description

A subclass of ImageFileFormat for reading and writing JPEG files.

See also

ImageFileFormat, PNGImageFormat

@tags{Graphics}

Constructor & Destructor Documentation

JPEGImageFormat()

juce::JPEGImageFormat::JPEGImageFormat

(

)

~JPEGImageFormat()

juce::JPEGImageFormat::~JPEGImageFormat ( )

override

Member Function Documentation

canUnderstand()

bool juce::JPEGImageFormat::canUnderstand ( InputStream & input )

overridevirtual

Returns true if the given stream seems to contain data that this format understands.

The format class should only read the first few bytes of the stream and sniff for header bytes that it understands.

Note that this will advance the stream and leave it in a new position, so if you're planning on re-using it, you may want to rewind it after calling this method.

See also

decodeImage

Implements juce::ImageFileFormat.

decodeImage()

Image juce::JPEGImageFormat::decodeImage ( InputStream & input )

overridevirtual

Tries to decode and return an image from the given stream.

This will be called for an image format after calling its canUnderStand() method to see if it can handle the stream.

Parameters

input

the stream to read the data from. The stream will be positioned at the start of the image data (but this may not necessarily be position 0)

Returns

the image that was decoded, or an invalid image if it fails.

See also

loadFrom

Implements juce::ImageFileFormat.

getFormatName()

String juce::JPEGImageFormat::getFormatName ( )

overridevirtual

Returns a description of this file format.

E.g. "JPEG", "PNG"

Implements juce::ImageFileFormat.

setQuality()

void juce::JPEGImageFormat::setQuality

(

float

newQuality

)

Specifies the quality to be used when writing a JPEG file.

Parameters

newQuality

a value 0 to 1.0, where 0 is low quality, 1.0 is best, or any negative value is "default" quality

usesFileExtension()

bool juce::JPEGImageFormat::usesFileExtension ( const File & possibleFile )

overridevirtual

Returns true if this format uses the file extension of the given file.

Implements juce::ImageFileFormat.

writeImageToStream()

bool juce::JPEGImageFormat::writeImageToStream ( const Image & sourceImage, OutputStream & destStream )

overridevirtual

Attempts to write an image to a stream.

To specify extra information like encoding quality, there will be appropriate parameters in the subclasses of the specific file types.

Returns

true if it nothing went wrong.

Implements juce::ImageFileFormat.

Member Data Documentation

quality

float juce::JPEGImageFormat::quality

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_ImageFileFormat.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_graphics/image_formats/juce_JPEGLoader.cpp