/usr/include/fg/image.h is in libforge-dev 0.9.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 | /*******************************************************
* Copyright (c) 2015-2019, ArrayFire
* All rights reserved.
*
* This file is distributed under 3-clause BSD license.
* The complete license agreement can be obtained at:
* http://arrayfire.com/licenses/BSD-3-Clause
********************************************************/
#pragma once
#include <fg/defines.h>
#ifdef __cplusplus
extern "C" {
#endif
/** \addtogroup image_functions
* @{
*/
/**
Create a Image object
\param[out] pImage will be set to created Image object
\param[in] pWidth Width of the image
\param[in] pHeight Height of the image
\param[in] pFormat Color channel format of image, uses one of the values
of \ref fg_channel_format
\param[in] pType takes one of the values of \ref fg_dtype that indicates
the integral data type of histogram data
\return \ref fg_err error code
*/
FGAPI fg_err fg_create_image(fg_image* pImage,
const unsigned pWidth, const unsigned pHeight,
const fg_channel_format pFormat, const fg_dtype pType);
/**
Destroy image object
\param[in] pImage is the image handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_destroy_image(fg_image pImage);
/**
Set a global alpha value for rendering the image
\param[in] pImage is the image handle
\param[in] pAlpha
\return \ref fg_err error code
*/
FGAPI fg_err fg_set_image_alpha(fg_image pImage, const float pAlpha);
/**
Set option to inform whether to maintain aspect ratio of original image
\param[in] pImage is the image handle
\param[in] pKeepRatio informs the image object if original aspect ratio has to be maintained
\return \ref fg_err error code
*/
FGAPI fg_err fg_set_image_aspect_ratio(fg_image pImage, const bool pKeepRatio);
/**
Get the width of the image
\param[out] pOut will be set to the width of the image
\param[in] pImage is the image handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_image_width(unsigned *pOut, const fg_image pImage);
/**
Get the height of the image
\param[out] pOut will be set to the height of the image
\param[in] pImage is the image handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_image_height(unsigned *pOut, const fg_image pImage);
/**
Get the channel format of the image
\param[out] pOut will be set to the channel format of the image
\param[in] pImage is the image handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_image_pixelformat(fg_channel_format* pOut, const fg_image pImage);
/**
Get the pixel data type of the image
\param[out] pOut will be set to the pixel data type of the image
\param[in] pImage is the image handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_image_type(fg_dtype* pOut, const fg_image pImage);
/**
Get the image buffer resource identifier
\param[out] pOut will be set to the image resource identifier
\param[in] pImage is the image handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_pixel_buffer(unsigned* pOut, const fg_image pImage);
/**
Get the image buffer size in bytes
\param[out] pOut will be set to the image buffer size in bytes
\param[in] pImage is the image handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_image_size(unsigned* pOut, const fg_image pImage);
/**
Render the image to given window
\param[in] pWindow is target window to where image will be rendered
\param[in] pImage is the image handle
\param[in] pX is x coordinate of origin of viewport in window coordinates
\param[in] pY is y coordinate of origin of viewport in window coordinates
\param[in] pWidth is the width of the viewport
\param[in] pHeight is the height of the viewport
\return \ref fg_err error code
*/
FGAPI fg_err fg_render_image(const fg_window pWindow,
const fg_image pImage,
const int pX, const int pY, const int pWidth, const int pHeight);
/** @} */
#ifdef __cplusplus
}
#endif
#ifdef __cplusplus
namespace forge
{
class Window;
/**
\class Image
\brief Image is plain rendering of an image over the window or sub-region of it.
*/
class Image {
private:
fg_image mValue;
public:
/**
Creates a Image object
\param[in] pWidth Width of the image
\param[in] pHeight Height of the image
\param[in] pFormat Color channel format of image, uses one of the values
of \ref ChannelFormat
\param[in] pDataType takes one of the values of \ref dtype that indicates
the integral data type of histogram data
*/
FGAPI Image(const unsigned pWidth, const unsigned pHeight,
const ChannelFormat pFormat=FG_RGBA, const dtype pDataType=f32);
/**
Copy constructor of Image
\param[in] pOther is the Image of which we make a copy of.
*/
FGAPI Image(const Image& pOther);
/**
Image Destructor
*/
FGAPI ~Image();
/**
Set a global alpha value for rendering the image
\param[in] pAlpha
*/
FGAPI void setAlpha(const float pAlpha);
/**
Set option to inform whether to maintain aspect ratio of original image
\param[in] pKeep
*/
FGAPI void keepAspectRatio(const bool pKeep);
/**
Get Image width
\return image width
*/
FGAPI unsigned width() const;
/**
Get Image height
\return image width
*/
FGAPI unsigned height() const;
/**
Get Image's channel format
\return \ref ChannelFormat value of Image
*/
FGAPI ChannelFormat pixelFormat() const;
/**
Get Image's integral data type
\return \ref dtype value of Image
*/
FGAPI dtype channelType() const;
/**
Get the resource id of image buffer
\return image buffer id
*/
FGAPI unsigned pixels() const;
/**
Get the image data size in bytes
\return image buffer size in bytes
*/
FGAPI unsigned size() const;
/**
Render the image to given window
\param[in] pWindow is target window to where image will be rendered
\param[in] pX is x coordinate of origin of viewport in window coordinates
\param[in] pY is y coordinate of origin of viewport in window coordinates
\param[in] pVPW is the width of the viewport
\param[in] pVPH is the height of the viewport
*/
FGAPI void render(const Window& pWindow,
const int pX, const int pY, const int pVPW, const int pVPH) const;
/**
Get the handle to internal implementation of Image
*/
FGAPI fg_image get() const;
};
}
#endif
|