Class Image

include/fg/image.h:174–282

\class Image \brief Image is plain rendering of an image over the window or sub-region of it. */

   \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);

        /**
          Construct Image ojbect from fg_image resource handle

          \param[in] pHandle is the input fg_image resource handle

          \note This kind of construction assumes ownership of the resource handle
          is released during the Image object's destruction.
         */
        FGAPI explicit Image(const fg_image pHandle);

        /**
           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
         */