class dlstreamer::OpenCLContext

Overview

#include <context.h>

class OpenCLContext: public dlstreamer::BaseContext {
public:
    // structs

    struct key;

    // construction

    OpenCLContext(cl_context ctx, cl_command_queue queue = nullptr);
    OpenCLContext(const ContextPtr& another_context);
    OpenCLContext(const OpenCLContext&);
    OpenCLContext(OpenCLContext&&);

    // methods

    static OpenCLContextPtr create(const ContextPtr& another_context);
    OpenCLContext& operator = (const OpenCLContext&);
    OpenCLContext& operator = (OpenCLContext&&);
    cl_context context();
    cl_command_queue queue();
    virtual std::vector<std::string> keys() const;
    virtual handle_t handle(std::string_view key) const;
    void flush();
    void finish();

    virtual MemoryMapperPtr get_mapper(
        const ContextPtr& input_context,
        const ContextPtr& output_context
    );
};

Inherited Members

public:
    // typedefs

    typedef void* handle_t;

    // structs

    struct key;

    // methods

    virtual MemoryType memory_type() const = 0;
    virtual handle_t handle(std::string_view key = {}) const = 0;

    virtual MemoryMapperPtr get_mapper(
        const ContextPtr& input_context,
        const ContextPtr& output_context
    ) = 0;

    virtual ContextPtr derive_context(MemoryType memory_type) = 0;
    virtual ContextPtr parent() = 0;
    virtual MemoryType memory_type() const;
    virtual handle_t handle(std::string_view key) const;
    virtual std::vector<std::string> keys() const;

    virtual MemoryMapperPtr get_mapper(
        const ContextPtr& input_context,
        const ContextPtr& output_context
    );

    virtual ContextPtr derive_context(MemoryType memory_type);
    virtual ContextPtr parent();
    void set_parent(ContextPtr parent);
    void set_memory_type(MemoryType memory_type);
    void attach_mapper(MemoryMapperPtr mapper);
    void remove_mapper(MemoryMapperPtr mapper);

Detailed Documentation

Methods

virtual handle_t handle(std::string_view key) const

Returns a handle by key. If empty key, returns default handle. If no handle with the specified key, returns 0.

Parameters:

key	the key of the handle to find

virtual MemoryMapperPtr get_mapper(
    const ContextPtr& input_context,
    const ContextPtr& output_context
)

Returns an object for memory mapping between two contexts. Function typically expects one of contexts to be this context. If one of contexts has memory type CPU or context reference is nullptr, function returns object for mapping to or from system memory. If creating memory mapping object failed, exception is thrown.

Parameters:

input_context	Context of input memory
output_context	Context of output memory