Open Search
    PixelMutableBuffer Struct Reference

    #include <gfx_image_pixelformat.h>

    Inheritance diagram for PixelMutableBuffer:

    Detailed Description

    Several functions use this helper structure to pass the image data to functions.

    Public Types

    using PIXELTYPE = Pix
     

    Public Member Functions

     PixelMutableBuffer ()=default
     
     PixelMutableBuffer (const PixelMutableBuffer &src)
     
     PixelMutableBuffer (const PixelMutableBuffer &src, Int offset)
     
     PixelMutableBuffer (Pix *buffer, BITS inc)
     
    PixelMutableBufferoperator= (const PixelMutableBuffer &src)
     
     operator const PixelConstBuffer & () const
     

    Public Attributes

    Pix_buffer
     
    BITS _inc
     

    Member Typedef Documentation

    ◆ PIXELTYPE

    using PIXELTYPE = Pix

    Constructor & Destructor Documentation

    ◆ PixelMutableBuffer() [1/4]

    PixelMutableBuffer ( )
    default

    ◆ PixelMutableBuffer() [2/4]

    Copy constructor.

    ◆ PixelMutableBuffer() [3/4]

    PixelMutableBuffer ( const PixelMutableBuffer src,
    Int  offset 
    )

    Copy constructor with alignment.

    ◆ PixelMutableBuffer() [4/4]

    PixelMutableBuffer ( Pix buffer,
    BITS  inc 
    )

    Constructs the helper object.

    Parameters
    [in]bufferPointer to the memory block of the pixel data.
    [in]incDistance in number of bytes from one pixel to the next. For packed pixels this value is equal to BytesPerPixel().

    Member Function Documentation

    ◆ operator=()

    PixelMutableBuffer& operator= ( const PixelMutableBuffer src)

    ◆ operator const PixelConstBuffer &()

    operator const PixelConstBuffer & ( ) const

    Member Data Documentation

    ◆ _buffer

    Pix* _buffer

    ◆ _inc

    BITS _inc