Skip to content

Class vl::EncodingSettings#

ClassList > vl > EncodingSettings

stores the settings for image encoding (e.g. JPEG parameters)

  • #include <encodedimage.h>

Public Functions#

Type Name
EncodingSettings ()
EncodingSettings (ImageEncoding enc)
construct new EncodingSettings with given encoding method
EncodingSettings (const EncodingSettings & enc) = default
construct new EncodingSettings with given encoding method
int getIntParam (JpgParameters par) const
generic getter for any JpgParameters
int getIntParam (PngParameters par) const
generic getter for any PngParameters
ImageEncoding method () const
get currently set encoding method
void setMethod (ImageEncoding method)
set new encoding method
void setParam (JpgParameters par, int val)
generic setter for any JpgParameters
void setParam (PngParameters par, int val)
generic setter for any PngParameters

Public Functions Documentation#

function EncodingSettings [1/3]#

vl::EncodingSettings::EncodingSettings () 

function EncodingSettings [2/3]#

construct new EncodingSettings with given encoding method

vl::EncodingSettings::EncodingSettings (
    ImageEncoding enc
) 

Parameters:

  • enc encoding method to be used

function EncodingSettings [3/3]#

construct new EncodingSettings with given encoding method

vl::EncodingSettings::EncodingSettings (
    const  EncodingSettings & enc
) = default

Parameters:

  • enc encoding method to be used

function getIntParam [1/2]#

generic getter for any JpgParameters

int vl::EncodingSettings::getIntParam (
    JpgParameters par
) const

Parameters:

  • par selector for JPG encoding parameter to read

Returns:

int value of parameter


function getIntParam [2/2]#

generic getter for any PngParameters

int vl::EncodingSettings::getIntParam (
    PngParameters par
) const

Parameters:

  • par selector for PNG encoding parameter to read

Returns:

int value of parameter


function method#

get currently set encoding method

ImageEncoding vl::EncodingSettings::method () const

Returns:

ImageEncoding method currently configured


function setMethod#

set new encoding method

void vl::EncodingSettings::setMethod (
    ImageEncoding method
) 

Parameters:

  • method ImageEncoding to be configured

function setParam [1/2]#

generic setter for any JpgParameters

void vl::EncodingSettings::setParam (
    JpgParameters par,
    int val
) 

Parameters:

  • par selector for JPG encoding parameter to set
  • val value to set

function setParam [2/2]#

generic setter for any PngParameters

void vl::EncodingSettings::setParam (
    PngParameters par,
    int val
) 

Parameters:

  • par selector for PNG encoding parameter to set
  • val value to set


The documentation for this class was generated from the following file docs/libvl/build/2.1.0/doxygen/source/vl/encodedimage.h