Image.h

Go to the documentation of this file.

//
// Copyright Contributors to the MaterialX Project
// SPDX-License-Identifier: Apache-2.0
//
 
#ifndef MATERIALX_IMAGE_H
#define MATERIALX_IMAGE_H

 
#include <MaterialXRender/Export.h>
 
#include <MaterialXFormat/File.h>
 
#include <MaterialXCore/Types.h>
 
MATERIALX_NAMESPACE_BEGIN
 
class Image;

using ImagePtr = shared_ptr<Image>;

using ConstImagePtr = shared_ptr<const Image>;

using ImageMap = std::unordered_map<string, ImagePtr>;

using ImageVec = std::vector<ImagePtr>;

using ImagePair = std::pair<ImagePtr, ImagePtr>;

using ImageBufferDeallocator = std::function<void(void*)>;

using UnsignedIntPair = std::pair<unsigned int, unsigned int>;

class MX_RENDER_API Image
{
  public:
    enum class BaseType
    {
        UINT8,
        INT8,
        UINT16,
        INT16,
        HALF,
        FLOAT
    };
 
  public:
    static ImagePtr create(unsigned int width, unsigned int height, unsigned int channelCount, BaseType baseType = BaseType::UINT8)
    {
        return ImagePtr(new Image(width, height, channelCount, baseType));
    }
 
    ~Image();


    unsigned int getWidth() const
    {
        return _width;
    }

    unsigned int getHeight() const
    {
        return _height;
    }

    unsigned int getChannelCount() const
    {
        return _channelCount;
    }

    BaseType getBaseType() const
    {
        return _baseType;
    }

    unsigned int getBaseStride() const;

    unsigned int getRowStride() const
    {
        return _width * _channelCount * getBaseStride();
    }

    unsigned int getMaxMipCount() const;


    void setTexelColor(unsigned int x, unsigned int y, const Color4& color);

    Color4 getTexelColor(unsigned int x, unsigned int y) const;


    Color4 getAverageColor();

    bool isUniformColor(Color4* uniformColor = nullptr);


    void setUniformColor(const Color4& color);

    void applyMatrixTransform(const Matrix33& mat);

    void applyGammaTransform(float gamma);

    ImagePtr copy(unsigned int channelCount, BaseType baseType) const;

    ImagePtr applyBoxBlur();

    ImagePtr applyGaussianBlur();

    ImagePtr applyBoxDownsample(unsigned int factor);

    ImagePair splitByLuminance(float luminance);

    void writeTable(const FilePath& filePath, unsigned int channel);


    void setResourceBuffer(void* buffer)
    {
        _resourceBuffer = buffer;
    }

    void* getResourceBuffer() const
    {
        return _resourceBuffer;
    }

    void createResourceBuffer();

    void releaseResourceBuffer();

    void setResourceBufferDeallocator(ImageBufferDeallocator deallocator)
    {
        _resourceBufferDeallocator = deallocator;
    }

    ImageBufferDeallocator getResourceBufferDeallocator() const
    {
        return _resourceBufferDeallocator;
    }


    void setResourceId(unsigned int id)
    {
        _resourceId = id;
    }

    unsigned int getResourceId() const
    {
        return _resourceId;
    }

 
  protected:
    Image(unsigned int width, unsigned int height, unsigned int channelCount, BaseType baseType);
 
  protected:
    unsigned int _width;
    unsigned int _height;
    unsigned int _channelCount;
    BaseType _baseType;
 
    void* _resourceBuffer;
    ImageBufferDeallocator _resourceBufferDeallocator;
    unsigned int _resourceId = 0;
};

MX_RENDER_API ImagePtr createUniformImage(unsigned int width, unsigned int height, unsigned int channelCount, Image::BaseType baseType, const Color4& color);

MX_RENDER_API ImagePtr createImageStrip(const vector<ImagePtr>& imageVec);

MX_RENDER_API UnsignedIntPair getMaxDimensions(const vector<ImagePtr>& imageVec);
 
MATERIALX_NAMESPACE_END
 
#endif