class cv::ocl::Image2D

Overview

#include <ocl.hpp>

class Image2D
{
public:
    // construction

    Image2D();

    Image2D(
        const UMat& src,
        bool norm = false,
        bool alias = false
        );

    Image2D(const Image2D& i);

    // methods

    Image2D&
    operator=(const Image2D& i);

    void*
    ptr() const;

    static
    bool
    canCreateAlias(const UMat& u);

    static
    bool
    isFormatSupported(
        int depth,
        int cn,
        bool norm
        );

protected:
    // fields

    Impl* p;
};

Detailed Documentation

Construction

Image2D(
    const UMat& src,
    bool norm = false,
    bool alias = false
    )

Parameters:

src	UMat object from which to get image properties and data
norm	flag to enable the use of normalized channel data types
alias	flag indicating that the image should alias the src UMat. If true, changes to the image or src will be reflected in both objects.

Methods

static
bool
canCreateAlias(const UMat& u)

Indicates if creating an aliased image should succeed. Depends on the underlying platform and the dimensions of the UMat.

static
bool
isFormatSupported(
    int depth,
    int cn,
    bool norm
    )

Indicates if the image format is supported.