1 ///////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (c) 2003, Industrial Light & Magic, a division of Lucas
4 // Digital Ltd. LLC
5 //
6 // All rights reserved.
7 //
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions are
10 // met:
11 // *       Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 // *       Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
16 // distribution.
17 // *       Neither the name of Industrial Light & Magic nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
33 ///////////////////////////////////////////////////////////////////////////
34 
35 
36 #ifndef INCLUDED_IMF_PREVIEW_IMAGE_H
37 #define INCLUDED_IMF_PREVIEW_IMAGE_H
38 
39 //-----------------------------------------------------------------------------
40 //
41 //	class PreviewImage -- a usually small, low-dynamic range image,
42 //	that is intended to be stored in an image file's header.
43 //
44 //	struct PreviewRgba -- holds the value of a PreviewImage pixel.
45 //
46 //-----------------------------------------------------------------------------
47 
48 namespace Imf {
49 
50 
51 struct PreviewRgba
52 {
53     unsigned char	r;	// Red, green and blue components of
54     unsigned char	g;	// the pixel's color; intensity is
55     unsigned char	b;	// proportional to pow (x/255, 2.2),
56                     // where x is r, g, or b.
57 
58     unsigned char	a;	// The pixel's alpha; 0 == transparent,
59                 // 255 == opaque.
60 
61     PreviewRgba (unsigned char r = 0,
62          unsigned char g = 0,
63          unsigned char b = 0,
64          unsigned char a = 255)
rPreviewRgba65     : r(r), g(g), b(b), a(a) {}
66 };
67 
68 
69 class PreviewImage
70 {
71   public:
72 
73     //--------------------------------------------------------------------
74     // Constructor:
75     //
76     // PreviewImage(w,h,p) constructs a preview image with w by h pixels
77     // whose initial values are specified in pixel array p.  The x and y
78     // coordinates of the pixels in p go from 0 to w-1, and from 0 to h-1.
79     // The pixel with coordinates (x, y) is at address p + y*w + x.
80     // Pixel (0, 0) is in the upper left corner of the preview image.
81     // If p is zero, the pixels in the preview image are initialized with
82     // (r = 0, b = 0, g = 0, a = 255).
83     //
84     //--------------------------------------------------------------------
85 
86      PreviewImage (unsigned int width = 0,
87            unsigned int height = 0,
88            const PreviewRgba pixels[] = 0);
89 
90     //-----------------------------------------------------
91     // Copy constructor, destructor and assignment operator
92     //-----------------------------------------------------
93 
94      PreviewImage (const PreviewImage &other);
95     ~PreviewImage ();
96 
97     PreviewImage &	operator = (const PreviewImage &other);
98 
99 
100     //-----------------------------------------------
101     // Access to width, height and to the pixel array
102     //-----------------------------------------------
103 
width()104     unsigned int	width () const	{return _width;}
height()105     unsigned int	height () const	{return _height;}
106 
pixels()107     PreviewRgba *	pixels ()	{return _pixels;}
pixels()108     const PreviewRgba *	pixels () const	{return _pixels;}
109 
110 
111     //----------------------------
112     // Access to individual pixels
113     //----------------------------
114 
pixel(unsigned int x,unsigned int y)115     PreviewRgba &	pixel (unsigned int x, unsigned int y)
116                         {return _pixels[y * _width + x];}
117 
pixel(unsigned int x,unsigned int y)118     const PreviewRgba &	pixel (unsigned int x, unsigned int y) const
119                         {return _pixels[y * _width + x];}
120 
121   private:
122 
123     unsigned int	_width;
124     unsigned int	_height;
125     PreviewRgba *	_pixels;
126 };
127 
128 
129 } // namespace Imf
130 
131 #endif
132