mf
Media Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Public Attributes | List of all members
mf::ndarray_generic_properties Struct Reference

Properties for construction of ndarray_generic and derived container objects. More...

#include <ndarray_generic.h>

Public Member Functions

const frame_formatformat () const noexcept
 
std::size_t frame_length () const noexcept
 
std::size_t array_length () const noexcept
 
std::size_t frame_size () const noexcept
 
 ndarray_generic_properties (const frame_format &format, std::size_t frame_length, std::size_t array_length)
 

Public Attributes

frame_format format_
 Element type and alignment of frame. More...
 
std::size_t frame_length_
 Number of elements in one frame. More...
 
std::size_t array_length_
 Number of frames. More...
 

Detailed Description

Properties for construction of ndarray_generic and derived container objects.

Described frame format, frame length and number of frames. Does not describe padding between array frames, because this may be determined internally by the container. (For example, ring needs to adjust is to fit page size.)

Constructor & Destructor Documentation

mf::ndarray_generic_properties::ndarray_generic_properties ( const frame_format format,
std::size_t  frame_length,
std::size_t  array_length 
)
inline

Member Function Documentation

std::size_t mf::ndarray_generic_properties::array_length ( ) const
inlinenoexcept
const frame_format& mf::ndarray_generic_properties::format ( ) const
inlinenoexcept
std::size_t mf::ndarray_generic_properties::frame_length ( ) const
inlinenoexcept
std::size_t mf::ndarray_generic_properties::frame_size ( ) const
inlinenoexcept

Member Data Documentation

std::size_t mf::ndarray_generic_properties::array_length_

Number of frames.

frame_format mf::ndarray_generic_properties::format_

Element type and alignment of frame.

std::size_t mf::ndarray_generic_properties::frame_length_

Number of elements in one frame.


The documentation for this struct was generated from the following file: