Blue Brain BioExplorer
core::ImageGenerator Class Reference

#include <ImageGenerator.h>

Classes

struct  ImageBase64
 
struct  ImageJPEG
 

Public Member Functions

 ImageGenerator ()=default
 
 ~ImageGenerator ()
 
ImageBase64 createImage (FrameBuffer &frameBuffer, const std::string &format, uint8_t quality)
 
ImageBase64 createImage (const std::vector< FrameBufferPtr > &frameBuffers, const std::string &format, uint8_t quality)
 
ImageJPEG createJPEG (FrameBuffer &frameBuffer, uint8_t quality)
 

Detailed Description

A class which creates images for network communication from a FrameBuffer.

Definition at line 34 of file ImageGenerator.h.

Constructor & Destructor Documentation

◆ ImageGenerator()

core::ImageGenerator::ImageGenerator ( )
default

◆ ~ImageGenerator()

core::ImageGenerator::~ImageGenerator ( )

Definition at line 32 of file ImageGenerator.cpp.

Member Function Documentation

◆ createImage() [1/2]

ImageGenerator::ImageBase64 core::ImageGenerator::createImage ( const std::vector< FrameBufferPtr > &  frameBuffers,
const std::string &  format,
uint8_t  quality 
)

Definition at line 45 of file ImageGenerator.cpp.

◆ createImage() [2/2]

ImageGenerator::ImageBase64 core::ImageGenerator::createImage ( FrameBuffer frameBuffer,
const std::string &  format,
uint8_t  quality 
)

Create a base64-encoded image from the given framebuffer in a specified image format and quality.

Parameters
frameBufferthe framebuffer to use for getting the pixels
formatFreeImage format string, or JPEG if FreeImage is not available
qualityimage format specific quality number
Returns
base64-encoded image
Exceptions
std::runtime_errorif image conversion failed or neither FreeImage nor TurboJPEG is available

Definition at line 38 of file ImageGenerator.cpp.

◆ createJPEG()

ImageGenerator::ImageJPEG core::ImageGenerator::createJPEG ( FrameBuffer frameBuffer,
uint8_t  quality 
)

Create a JPEG image from the given framebuffer in a specified quality.

Parameters
frameBufferthe framebuffer to use for getting the pixels
quality1..100 JPEG quality
Returns
JPEG image with a size > 0 if valid, size == 0 on error.

Definition at line 58 of file ImageGenerator.cpp.


The documentation for this class was generated from the following files: