Fawkes API  Fawkes Development Version
firevision::SharedMemoryImageBufferMetaData Class Reference

Shared memory image buffer meta data container. More...

#include <>>

Public Member Functions

 SharedMemoryImageBufferMetaData ()
 Constructor. More...
 
 SharedMemoryImageBufferMetaData (const char *image_id, const char *frame_id, colorspace_t colorspace, unsigned int width, unsigned int height, size_t mem_size, bool mem_swapable, bool mem_destroyed)
 Value constructor. More...
 

Public Attributes

std::string image_id
 Image buffer ID. More...
 
std::string frame_id
 Coordinate frame ID. More...
 
colorspace_t colorspace
 Colorspace. More...
 
unsigned int width
 Image width. More...
 
unsigned int height
 Image height. More...
 
size_t mem_size
 Shared memory buffer size. More...
 
bool mem_swapable
 True if memory might be moved to swap space. More...
 
bool mem_destroyed
 True if memory has already been marked destroyed. More...
 

Detailed Description

Shared memory image buffer meta data container.

Definition at line 135 of file shm_image.h.

Constructor & Destructor Documentation

◆ SharedMemoryImageBufferMetaData() [1/2]

◆ SharedMemoryImageBufferMetaData() [2/2]

firevision::SharedMemoryImageBufferMetaData::SharedMemoryImageBufferMetaData ( const char *  image_id,
const char *  frame_id,
colorspace_t  colorspace,
unsigned int  width,
unsigned int  height,
size_t  mem_size,
bool  mem_swapable,
bool  mem_destroyed 
)

Value constructor.

Parameters
image_idImage buffer ID
frame_idCoordinate frame ID
colorspaceColorspace
widthImage width
heightImage height
mem_sizeShared memory buffer size
mem_swapableTrue if memory might be moved to swap space
mem_destroyedTrue if memory has already been marked destroyed

Definition at line 1024 of file shm_image.cpp.

References firevision::SharedMemoryImageBuffer::colorspace(), firevision::SharedMemoryImageBuffer::frame_id(), firevision::SharedMemoryImageBuffer::height(), firevision::SharedMemoryImageBuffer::image_id(), and firevision::SharedMemoryImageBuffer::width().

Member Data Documentation

◆ colorspace

colorspace_t firevision::SharedMemoryImageBufferMetaData::colorspace

Colorspace.

Definition at line 140 of file shm_image.h.

Referenced by WebviewImageRequestProcessor::process_request().

◆ frame_id

std::string firevision::SharedMemoryImageBufferMetaData::frame_id

Coordinate frame ID.

Definition at line 139 of file shm_image.h.

Referenced by WebviewImageRequestProcessor::process_request().

◆ height

unsigned int firevision::SharedMemoryImageBufferMetaData::height

Image height.

Definition at line 142 of file shm_image.h.

Referenced by WebviewImageRequestProcessor::process_request().

◆ image_id

std::string firevision::SharedMemoryImageBufferMetaData::image_id

Image buffer ID.

Definition at line 138 of file shm_image.h.

Referenced by WebviewImageRequestProcessor::process_request().

◆ mem_destroyed

bool firevision::SharedMemoryImageBufferMetaData::mem_destroyed

True if memory has already been marked destroyed.

Definition at line 146 of file shm_image.h.

◆ mem_size

size_t firevision::SharedMemoryImageBufferMetaData::mem_size

Shared memory buffer size.

Definition at line 144 of file shm_image.h.

Referenced by WebviewImageRequestProcessor::process_request().

◆ mem_swapable

bool firevision::SharedMemoryImageBufferMetaData::mem_swapable

True if memory might be moved to swap space.

Definition at line 145 of file shm_image.h.

◆ width

unsigned int firevision::SharedMemoryImageBufferMetaData::width

Image width.

Definition at line 141 of file shm_image.h.

Referenced by WebviewImageRequestProcessor::process_request().


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