comparison Core/Enumerations.h @ 593:9d2592c08919

documentation completed
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 04 Oct 2013 15:04:37 +0200
parents bf2fda1c6760
children ce5d2040c47b
comparison
equal deleted inserted replaced
592:c5ee586a0a08 593:9d2592c08919
67 ErrorCode_UnknownResource, 67 ErrorCode_UnknownResource,
68 ErrorCode_IncompatibleDatabaseVersion, 68 ErrorCode_IncompatibleDatabaseVersion,
69 ErrorCode_FullStorage 69 ErrorCode_FullStorage
70 }; 70 };
71 71
72 /**
73 * {summary}{The memory layout of the pixels (resp. voxels) of a 2D (resp. 3D) image.}
74 **/
72 enum LAAW_API PixelFormat 75 enum LAAW_API PixelFormat
73 { 76 {
77 /**
78 * {summary}{Color image in RGB24 format.}
79 * {description}{This format describes a color image. The pixels are stored in 3
80 * consecutive bytes. The memory layout is RGB.
81 **/
74 PixelFormat_RGB24, 82 PixelFormat_RGB24,
83
84 /**
85 * {summary}{Graylevel 8bpp image.}
86 * {description}{The image is graylevel. Each pixel is unsigned and stored in one byte.}
87 **/
75 PixelFormat_Grayscale8, 88 PixelFormat_Grayscale8,
89
90 /**
91 * {summary}{Graylevel, unsigned 16bpp image.}
92 * {description}{The image is graylevel. Each pixel is unsigned and stored in two bytes.}
93 **/
76 PixelFormat_Grayscale16, 94 PixelFormat_Grayscale16,
95
96 /**
97 * {summary}{Graylevel, signed 16bpp image.}
98 * {description}{The image is graylevel. Each pixel is signed and stored in two bytes.}
99 **/
77 PixelFormat_SignedGrayscale16 100 PixelFormat_SignedGrayscale16
78 }; 101 };
79 102
103
104 /**
105 * {summary}{The extraction mode specifies the way the values of the pixels are scaled when downloading a 2D image.}
106 **/
80 enum LAAW_API ImageExtractionMode 107 enum LAAW_API ImageExtractionMode
81 { 108 {
109 /**
110 * {summary}{Rescaled to 8bpp.}
111 * {description}{The minimum value of the image is set to 0, and its maximum value is set to 255.}
112 **/
82 ImageExtractionMode_Preview, 113 ImageExtractionMode_Preview,
114
115 /**
116 * {summary}{Truncation to the [0, 255] range.}
117 **/
83 ImageExtractionMode_UInt8, 118 ImageExtractionMode_UInt8,
119
120 /**
121 * {summary}{Truncation to the [0, 65535] range.}
122 **/
84 ImageExtractionMode_UInt16, 123 ImageExtractionMode_UInt16,
124
125 /**
126 * {summary}{Truncation to the [-32768, 32767] range.}
127 **/
85 ImageExtractionMode_Int16 128 ImageExtractionMode_Int16
86 }; 129 };
87 130
88 131
89 /** 132 /**