HalideRuntimeOpenGLCompute.h

Go to the documentation of this file.

#ifndef HALIDE_HALIDERUNTIMEOPENGLCOMPUTE_H
#define HALIDE_HALIDERUNTIMEOPENGLCOMPUTE_H
 
// Don't include HalideRuntime.h if the contents of it were already pasted into a generated header above this one
#ifndef HALIDE_HALIDERUNTIME_H
 
#include "HalideRuntime.h"
 
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/** \file
 *  Routines specific to the Halide OpenGL Compute runtime.
 */
 
#define HALIDE_RUNTIME_OPENGLCOMPUTE
 
HALIDE_ATTRIBUTE_DEPRECATED("OpenGLCompute is deprecated in Halide 16 and will be removed in Halide 17.")
extern const struct halide_device_interface_t *halide_openglcompute_device_interface();
 
/** These are forward declared here to allow clients to override the
 *  Halide Glsl runtime. Do not call them. */
// @{
 
/** This function sets up OpenGL context, loads relevant GL functions, then
 *  compiles src OpenGL compute shader into OpenGL program and stores it for future use.
 */
HALIDE_ATTRIBUTE_DEPRECATED("OpenGLCompute is deprecated in Halide 16 and will be removed in Halide 17.")
extern int halide_openglcompute_initialize_kernels(void *user_context, void **state_ptr,
                                                   const char *src, int size);
 
/** This function triggers execution of OpenGL program built around compute shader.
 *  Execution of the shader is parallelized into given number of blocks and threads.
 *
 *  This function doesn't wait for the completion of the shader, but it sets memory
 *  barrier which forces successive retrieval of output data to wait until shader is done.
 */
HALIDE_ATTRIBUTE_DEPRECATED("OpenGLCompute is deprecated in Halide 16 and will be removed in Halide 17.")
extern int halide_openglcompute_run(void *user_context,
                                    void *state_ptr,
                                    const char *entry_name,
                                    int blocksX, int blocksY, int blocksZ,
                                    int threadsX, int threadsY, int threadsZ,
                                    int shared_mem_bytes,
                                    struct halide_type_t arg_types[],
                                    void *args[],
                                    int8_t is_buffer[]);
 
HALIDE_ATTRIBUTE_DEPRECATED("OpenGLCompute is deprecated in Halide 16 and will be removed in Halide 17.")
extern void halide_openglcompute_finalize_kernels(void *user_context, void *state_ptr);
// @}
 
/** This function retrieves pointers to OpenGL API functions.
 *
 *  You may have to implement this yourself. Halide only provides implementations
 *  for some platforms."
 */
HALIDE_ATTRIBUTE_DEPRECATED("OpenGLCompute is deprecated in Halide 16 and will be removed in Halide 17.")
extern void *halide_opengl_get_proc_address(void *user_context, const char *name);
 
/** This function creates an OpenGL context for use by the OpenGL backend.
 *
 *  You may have to implement this yourself as well. Halide only provides
 *   implementations for some platforms."
 */
HALIDE_ATTRIBUTE_DEPRECATED("OpenGLCompute is deprecated in Halide 16 and will be removed in Halide 17.")
extern int halide_opengl_create_context(void *user_context);
 
#ifdef __cplusplus
}  // End extern "C"
#endif
 
#endif  // HALIDE_HALIDERUNTIMEOPENGLCOMPUTE_H