[occt.git] / src / Image / Image_Format.hxx

// Copyright (c) 2012-2017 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _Image_Format_HeaderFile
#define _Image_Format_HeaderFile

//! This enumeration defines packed image plane formats
enum Image_Format
{
  Image_Format_UNKNOWN = 0, //!< unsupported or unknown format
  Image_Format_Gray    = 1, //!< 1 byte per pixel, intensity of the color
  Image_Format_Alpha,       //!< 1 byte per pixel, transparency
  Image_Format_RGB,         //!< 3 bytes packed RGB image plane
  Image_Format_BGR,         //!< same as RGB but with different components order
  Image_Format_RGB32,       //!< 4 bytes packed RGB image plane (1 extra byte for alignment, may have undefined value)
  Image_Format_BGR32,       //!< same as RGB but with different components order
  Image_Format_RGBA,        //!< 4 bytes packed RGBA image plane
  Image_Format_BGRA,        //!< same as RGBA but with different components order
  Image_Format_GrayF,       //!< 1 float  (4-bytes) per pixel (1-component plane), intensity of the color
  Image_Format_AlphaF,      //!< 1 float  (4-bytes) per pixel (1-component plane), transparency
  Image_Format_RGF,         //!< 2 floats (8-bytes) RG image plane
  Image_Format_RGBF,        //!< 3 floats (12-bytes) RGB image plane
  Image_Format_BGRF,        //!< same as RGBF but with different components order
  Image_Format_RGBAF,       //!< 4 floats (16-bytes) RGBA image plane
  Image_Format_BGRAF,       //!< same as RGBAF but with different components order
};
enum { Image_Format_NB = Image_Format_BGRAF + 1 };

#endif // _Image_Format_HeaderFile
Commit	Line	Data
dc858f4c	1	// Copyright (c) 2012-2017 OPEN CASCADE SAS
	2	//
	3	// This file is part of Open CASCADE Technology software library.
	4	//
	5	// This library is free software; you can redistribute it and/or modify it under
	6	// the terms of the GNU Lesser General Public License version 2.1 as published
	7	// by the Free Software Foundation, with special exception defined in the file
	8	// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	9	// distribution for complete text of the license and disclaimer of any warranty.
	10	//
	11	// Alternatively, this file may be used under the terms of Open CASCADE
	12	// commercial license or contractual agreement.
	13
	14	#ifndef _Image_Format_HeaderFile
	15	#define _Image_Format_HeaderFile
	16
	17	//! This enumeration defines packed image plane formats
	18	enum Image_Format
	19	{
	20	Image_Format_UNKNOWN = 0, //!< unsupported or unknown format
	21	Image_Format_Gray = 1, //!< 1 byte per pixel, intensity of the color
	22	Image_Format_Alpha, //!< 1 byte per pixel, transparency
	23	Image_Format_RGB, //!< 3 bytes packed RGB image plane
	24	Image_Format_BGR, //!< same as RGB but with different components order
	25	Image_Format_RGB32, //!< 4 bytes packed RGB image plane (1 extra byte for alignment, may have undefined value)
	26	Image_Format_BGR32, //!< same as RGB but with different components order
	27	Image_Format_RGBA, //!< 4 bytes packed RGBA image plane
	28	Image_Format_BGRA, //!< same as RGBA but with different components order
	29	Image_Format_GrayF, //!< 1 float (4-bytes) per pixel (1-component plane), intensity of the color
	30	Image_Format_AlphaF, //!< 1 float (4-bytes) per pixel (1-component plane), transparency
67312b79	31	Image_Format_RGF, //!< 2 floats (8-bytes) RG image plane
dc858f4c	32	Image_Format_RGBF, //!< 3 floats (12-bytes) RGB image plane
	33	Image_Format_BGRF, //!< same as RGBF but with different components order
	34	Image_Format_RGBAF, //!< 4 floats (16-bytes) RGBA image plane
	35	Image_Format_BGRAF, //!< same as RGBAF but with different components order
	36	};
faff3767	37	enum { Image_Format_NB = Image_Format_BGRAF + 1 };
dc858f4c	38
dc858f4c	39	#endif // _Image_Format_HeaderFile