Ocean
Ocean::IO::Image Namespace Reference

Namespace of the Ocean IO Image library. More...

Data Structures

class  Comfort
 This class provides functions for image encoding and decoding which will increase binary size when used. More...
 

Typedefs

using Properties = Media::Image::Properties
 Re-definition of Media::Image::Properties. More...
 

Functions

OCEAN_IO_IMAGE_EXPORT Frame decodeImage (const void *buffer, const size_t size, const std::string &imageBufferTypeIn=std::string(), std::string *imageBufferTypeOut=nullptr)
 Decodes (reads/loads) an image from a given binary buffer. More...
 
OCEAN_IO_IMAGE_EXPORT bool encodeImage (const Frame &frame, const std::string &imageType, std::vector< uint8_t > &buffer, const Properties &properties=Properties())
 Encodes (writes) a given frame as image (with specified image type) to a resulting buffer. More...
 
OCEAN_IO_IMAGE_EXPORT Frame readImage (const std::string &filename)
 Reads/loads an image from a specified file. More...
 
OCEAN_IO_IMAGE_EXPORT bool writeImage (const Frame &frame, const std::string &filename, const Properties &properties=Properties())
 Writes a given frame to a specified file. More...
 
static bool encodeImage (const Frame &, const std::string &, std::vector< uint8_t > &, const float)=delete
 Disabled function to prevent wrong usage. More...
 
static bool writeImage (const Frame &, const std::string &, const float)=delete
 Disabled function to prevent wrong usage. More...
 

Detailed Description

Namespace of the Ocean IO Image library.

The Namespace Ocean::IO::Image is used in the entire Ocean IO Image library.

Typedef Documentation

◆ Properties

Function Documentation

◆ encodeImage()

static bool Ocean::IO::Image::encodeImage ( const Frame ,
const std::string &  ,
std::vector< uint8_t > &  ,
const float   
)
staticdelete

Disabled function to prevent wrong usage.

Returns
Would return True on success

◆ writeImage()

static bool Ocean::IO::Image::writeImage ( const Frame ,
const std::string &  ,
const float   
)
staticdelete

Disabled function to prevent wrong usage.

Returns
Would return True on success