Open Search
    ImageInterface Class Reference

    #include <gfx_image.h>

    Inheritance diagram for ImageInterface:

    Detailed Description

    The ImageInterface represents a single image with a ImageTextureRef. one or more Images can be part of a ImageTextureRef.

    Public Member Functions

    MAXON_METHOD Result< void > Init (Int width, Int height, const Class< ImagePixelStorage > &storageFormat, const PixelFormat &pixelFormat, const Block< Pix > *defaultColor=nullptr)
     

    Private Member Functions

     MAXON_INTERFACE (ImageInterface, MAXON_REFERENCE_NORMAL, "net.maxon.image.interface.image")
     

    Member Function Documentation

    ◆ MAXON_INTERFACE()

    MAXON_INTERFACE ( ImageInterface  ,
    MAXON_REFERENCE_NORMAL  ,
    "net.maxon.image.interface.image"   
    )
    private

    ◆ Init()

    MAXON_METHOD Result<void> Init ( Int  width,
    Int  height,
    const Class< ImagePixelStorage > &  storageFormat,
    const PixelFormat &  pixelFormat,
    const Block< Pix > *  defaultColor = nullptr 
    )

    Initializes the pixel storage.

    Parameters
    [in]widthWidth of the image data.
    [in]heightHeight of the image data.
    [in]storageFormatStorage format of the pixel data.
    [in]pixelFormatPixel format of the pixel storage.
    [in]defaultColorOptional default color to return if no image data is present. Must be in the given PixelFormat. Can be nullptr.
    Returns
    OK on success.