Image::Frame Class Reference

#include <Image.h>

Description

A 2D matrix of pixels.

Functions

 Frame ()
 
 Frame (uint32_t w, uint32_t h)
 
 Frame (uint32_t w, uint32_t h, const std::vector< uint8_t > &data)
 
 Frame (const Frame &other)
 
std::vector< uint8_t > GetData () const
 
void SetData (const std::vector< uint8_t > &data)
 
uint32_t Width () const
 
uint32_t Height () const
 
std::vector< FrameDetilize (uint32_t smallWidth, uint32_t smallHeight) const
 
int GetHandle () const
 

Constructor & Destructor Documentation

Frame ( )

Creates an empty Frame.

Frame ( uint32_t  w,
uint32_t  h 
)

Creates an empty Frame with a specified width/height.

Frame ( uint32_t  w,
uint32_t  h,
const std::vector< uint8_t > &  data 
)

Creates a Frame from the given raw data.

Frame ( const Frame other)

Creates a Frame as a copy of another.

Member Function Documentation

std::vector<uint8_t> GetData ( ) const

Returns the raw pixel data of a frame.

void SetData ( const std::vector< uint8_t > &  data)

Updates a frame with the given pixel data. Note that the data must match in dimensions the current Width/Height of the Frame.

uint32_t Width ( ) const

Returns the width of the frame.

uint32_t Height ( ) const

Returns the height of the frame.

std::vector<Frame> Detilize ( uint32_t  smallWidth,
uint32_t  smallHeight 
) const

Splits the frame into many sub-frames, each with the specified smallWidth and smallHeight.

int GetHandle ( ) const

Returns the object handle to be used with the Renderer.


The documentation for this class was generated from the following file:
  • /home/jc/git/Dynacoe/DynacoeSrc/includes/Dynacoe/Image.h