ADTF  3.13.2
streamimageformat.h File Reference

Copyright © Audi Electronics Venture GmbH. More...

Go to the source code of this file.

Classes

struct  tStreamImageFormat
 Simple Stream Type and Stream Meta Type definition for video frames or an image sequence as a convenience stucture. More...
 

Namespaces

 adtf
 Namespace for entire ADTF SDK.
 
 adtf::streaming
 Namespace for the ADTF Streaming SDK.
 
 adtf::streaming::ant
 Namespace for all functionality of the ADTF Streaming SDK provided since v3.0.
 
 adtf::streaming::ant::imageformat_definition
 Namespace to sort pixelformat descriptions.
 
 adtf::streaming::stream_image_format
 Container namespace to predefine some common imageformats within ADTF - see also Generic Pixel Format.
 

Macros

#define ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME   24
 defined Max byte size for tStreamImageFormatName
 
#define ADTF_DEFINE_STREAM_IMAGE_FORMAT(_FORMAT_STRUCT_TYPE_, _FORMAT_NAME_)
 Internal helper to create an image format do not use to define your own ! More...
 
#define ADTF_IMAGE_FORMAT(_FORMAT_)   ::adtf::streaming::stream_image_format::_FORMAT_::FormatName
 Helper Macro to get the FormatName of the predefined Format within stream_image_format. More...
 

Typedefs

typedef adtf_util::stack_string_base< ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME, adtf_util::assert_out_of_range > cStreamFormatStorageType
 formatname storage type (max byte size defined by ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME)
 
typedef adtf_util::string_base< cStreamFormatStorageType > tStreamImageFormatName
 formatname type as stack string (max byte size defined by ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME)
 

Functions

tBool operator!= (const tStreamImageFormat &sLeft, const tStreamImageFormat &sRight)
 is not equal operator to compare tStreamImageFormat More...
 
tBool operator== (const tStreamImageFormat &sLeft, const tStreamImageFormat &sRight)
 is equal operator to compare tStreamImageFormat More...
 
 ADTF_DEFINE_STREAM_IMAGE_FORMAT (RGB_8, "R(3)G(3)B(2)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(RGB_555
 BYTE ORDER FORMAT DESCRIPTION Format definition. More...
 
 R (5) G(5) B(5)(1)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(RGB_565
 Format definition.
 
 R (8) G(8) B(8)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(BGR_24
 Format definition. More...
 
 B (8) G(8) R(8)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(RGB_32
 Format definition this description means always first in lowest bit of lowest byte.
 
 A (8) B(8) G(8) R(8)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(ARGB_32
 Format definition this description means always first in lowest bit of lowest byte.
 
 A (8) R(8) G(8) B(8)") tBool stream_image_format_is_generic_greyscale( const tStreamImageFormat & strFormat)
 Format definition. More...
 
tBool stream_image_format_is_generic_rgb (const tStreamImageFormat &strFormat)
 Check if R, G and B components are available in Generic Pixel Format. More...
 
tBool stream_image_format_is_generic (const tStreamImageFormat &strFormat)
 Check if all bits are well defined and at least one component is available in Generic Pixel Format. More...
 
tUInt stream_image_format_get_generic_pixel_size (const tStreamImageFormat &strFormat)
 Retrieves the pixelsize by a Generic Pixel Format. More...
 
tUInt32 stream_image_format_get_generic_mask (const tChar *strChannel, const tStreamImageFormat &strFormat)
 Retrieves the pixelsize by a Generic Pixel Format. More...
 

Detailed Description

Copyright © Audi Electronics Venture GmbH.

All rights reserved

Definition in file streamimageformat.h.

Macro Definition Documentation

◆ ADTF_DEFINE_STREAM_IMAGE_FORMAT

#define ADTF_DEFINE_STREAM_IMAGE_FORMAT (   _FORMAT_STRUCT_TYPE_,
  _FORMAT_NAME_ 
)
Value:
namespace imageformat_definition \
{ \
struct _FORMAT_STRUCT_TYPE_ \
{ \
static constexpr const tChar *const FormatName = _FORMAT_NAME_; \
}; \
}
char tChar
The tChar defines the type for platform character set (platform and compiler dependent type)...

Internal helper to create an image format do not use to define your own !

Definition at line 72 of file streamimageformat.h.

◆ ADTF_IMAGE_FORMAT

#define ADTF_IMAGE_FORMAT (   _FORMAT_)    ::adtf::streaming::stream_image_format::_FORMAT_::FormatName

Helper Macro to get the FormatName of the predefined Format within stream_image_format.

Parameters
_FORMAT_Format Type (see imageformat_definition)

Definition at line 183 of file streamimageformat.h.


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue Nov 16 2021 by doxygen 1.8.14)