ccl_sampler_wrapper.h

Go to the documentation of this file.

/*
 * This file is part of cf4ocl (C Framework for OpenCL).
 *
 * cf4ocl is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * cf4ocl is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with cf4ocl. If not, see
 * <http://www.gnu.org/licenses/>.
 * */

#ifndef _CCL_SAMPLER_WRAPPER_H_
#define _CCL_SAMPLER_WRAPPER_H_

#include "ccl_abstract_wrapper.h"
#include "ccl_context_wrapper.h"

/* Get the sampler wrapper for the given OpenCL sampler. */
CCL_EXPORT
CCLSampler* ccl_sampler_new_wrap(cl_sampler sampler);

/* Decrements the reference count of the wrapper object. If it
 * reaches 0, the wrapper object is destroyed. */
CCL_EXPORT
void ccl_sampler_destroy(CCLSampler* smplr);

/* Create a new sampler wrapper object by specifying a basic set of
 * sampler properties. */
CCL_EXPORT
CCLSampler* ccl_sampler_new(CCLContext* ctx, cl_bool normalized_coords,
    cl_addressing_mode addressing_mode, cl_filter_mode filter_mode,
    CCLErr** err);

/* Create a new sampler wrapper object using a list of properties. */
CCL_EXPORT
CCLSampler* ccl_sampler_new_full(CCLContext* ctx,
    const cl_sampler_properties *sampler_properties, CCLErr** err);

#define ccl_sampler_get_info(smplr, param_name, err) \
    ccl_wrapper_get_info((CCLWrapper*) smplr, NULL, param_name, 0, \
        CCL_INFO_SAMPLER, CL_FALSE, err)

#define ccl_sampler_get_info_scalar(smplr, param_name, param_type, err) \
    *((param_type*) ccl_wrapper_get_info_value((CCLWrapper*) smplr, \
        NULL, param_name, sizeof(param_type), CCL_INFO_SAMPLER, CL_FALSE, err))

#define ccl_sampler_get_info_array(smplr, param_name, param_type, err) \
    (param_type) ccl_wrapper_get_info_value((CCLWrapper*) smplr, \
        NULL, param_name, sizeof(param_type), CCL_INFO_SAMPLER, CL_FALSE, err)

#define ccl_sampler_ref(smplr) \
    ccl_wrapper_ref((CCLWrapper*) smplr)

#define ccl_sampler_unref(smplr) ccl_sampler_destroy(smplr)

#define ccl_sampler_unwrap(smplr) \
    ((cl_sampler) ccl_wrapper_unwrap((CCLWrapper*) smplr))

#endif