Halide
halide_buffer_t Struct Reference

The raw representation of an image passed around by generated Halide code. More...

#include <HalideRuntime.h>

Public Attributes

uint64_t device
 A device-handle for e.g. More...
 
const struct halide_device_interface_tdevice_interface
 The interface used to interpret the above handle. More...
 
uint8_thost
 A pointer to the start of the data in main memory. More...
 
uint64_t flags
 flags with various meanings. More...
 
struct halide_type_t type
 The type of each buffer element. More...
 
int32_t dimensions
 The dimensionality of the buffer. More...
 
halide_dimension_tdim
 The shape of the buffer. More...
 
void * padding
 Pads the buffer up to a multiple of 8 bytes. More...
 

Detailed Description

The raw representation of an image passed around by generated Halide code.

It includes some stuff to track whether the image is not actually in main memory, but instead on a device (like a GPU). For a more convenient C++ wrapper, use Halide::Buffer<T>.

Definition at line 1404 of file HalideRuntime.h.

Member Data Documentation

◆ device

uint64_t halide_buffer_t::device

A device-handle for e.g.

GPU memory used to back this buffer.

Definition at line 1406 of file HalideRuntime.h.

Referenced by Halide::Runtime::Internal::make_buffer_copy().

◆ device_interface

const struct halide_device_interface_t* halide_buffer_t::device_interface

The interface used to interpret the above handle.

Definition at line 1409 of file HalideRuntime.h.

◆ host

uint8_t* halide_buffer_t::host

A pointer to the start of the data in main memory.

In terms of the Halide coordinate system, this is the address of the min coordinates (defined below).

Definition at line 1414 of file HalideRuntime.h.

Referenced by Halide::Runtime::Internal::make_buffer_copy().

◆ flags

uint64_t halide_buffer_t::flags

flags with various meanings.

Definition at line 1417 of file HalideRuntime.h.

◆ type

◆ dimensions

int32_t halide_buffer_t::dimensions

The dimensionality of the buffer.

Definition at line 1423 of file HalideRuntime.h.

Referenced by Halide::Runtime::Internal::calc_device_crop_byte_offset(), and Halide::Runtime::Internal::make_buffer_copy().

◆ dim

halide_dimension_t* halide_buffer_t::dim

◆ padding

void* halide_buffer_t::padding

Pads the buffer up to a multiple of 8 bytes.

Definition at line 1430 of file HalideRuntime.h.


The documentation for this struct was generated from the following file: