Halide
HalideRuntimeD3D12Compute.h File Reference
#include "HalideRuntime.h"

Go to the source code of this file.

Functions

const struct halide_device_interface_thalide_d3d12compute_device_interface ()
 
int halide_d3d12compute_initialize_kernels (void *user_context, void **state_ptr, const char *src, int size)
 These are forward declared here to allow clients to override the Halide Direct3D 12 Compute runtime. More...
 
int halide_d3d12compute_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, size_t arg_sizes[], void *args[], int8_t arg_is_buffer[], int num_attributes, float *vertex_buffer, int num_coords_dim0, int num_coords_dim1)
 
int halide_d3d12compute_wrap_buffer (void *user_context, struct halide_buffer_t *buf, uint64_t d3d12_resource)
 Set the underlying ID3D12Resource for a halide_buffer_t. More...
 
int halide_d3d12compute_detach_buffer (void *user_context, struct halide_buffer_t *buf)
 Disconnect a halide_buffer_t from the ID3D12Resource it was previously wrapped around. More...
 
uintptr_t halide_d3d12compute_get_buffer (void *user_context, struct halide_buffer_t *buf)
 Return the underlying ID3D12Resource for a halide_buffer_t. More...
 
int halide_d3d12compute_acquire_context (void *user_context, struct halide_d3d12compute_device **device_ret, struct halide_d3d12compute_command_queue **queue_ret, bool create)
 This prototype is exported as applications will typically need to replace it to get Halide filters to execute on the same device and command queue used for other purposes. More...
 
int halide_d3d12compute_release_context (void *user_context)
 This call balances each successfull halide_d3d12compute_acquire_context call. More...
 

Detailed Description

Routines specific to the Halide Direct3D 12 Compute runtime.

Definition in file HalideRuntimeD3D12Compute.h.

Function Documentation

◆ halide_d3d12compute_device_interface()

const struct halide_device_interface_t* halide_d3d12compute_device_interface ( )

◆ halide_d3d12compute_initialize_kernels()

int halide_d3d12compute_initialize_kernels ( void *  user_context,
void **  state_ptr,
const char *  src,
int  size 
)

These are forward declared here to allow clients to override the Halide Direct3D 12 Compute runtime.

Do not call them.

◆ halide_d3d12compute_run()

int halide_d3d12compute_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,
size_t  arg_sizes[],
void *  args[],
int8_t  arg_is_buffer[],
int  num_attributes,
float *  vertex_buffer,
int  num_coords_dim0,
int  num_coords_dim1 
)

◆ halide_d3d12compute_wrap_buffer()

int halide_d3d12compute_wrap_buffer ( void *  user_context,
struct halide_buffer_t buf,
uint64_t  d3d12_resource 
)

Set the underlying ID3D12Resource for a halide_buffer_t.

The memory backing the resource should be managed by the caller (via a default/device heap) and must be large enough to cover the extent of the halide_buffer_t. The device field of the halide_buffer_t must be NULL when this routine is called. This call can fail due to running out of memory or if an invalid D3D12 resource is passed. The device and host dirty bits are left unmodified.

◆ halide_d3d12compute_detach_buffer()

int halide_d3d12compute_detach_buffer ( void *  user_context,
struct halide_buffer_t buf 
)

Disconnect a halide_buffer_t from the ID3D12Resource it was previously wrapped around.

Should only be called for a halide_buffer_t that halide_d3d12compute_wrap_buffer was previously called on. Frees any storage associated with the binding of the halide_buffer_t and the buffer, but does not free the ID3D12Resource. The dev field of the halide_buffer_t will be NULL on return.

◆ halide_d3d12compute_get_buffer()

uintptr_t halide_d3d12compute_get_buffer ( void *  user_context,
struct halide_buffer_t buf 
)

Return the underlying ID3D12Resource for a halide_buffer_t.

This resource must be valid on an D3D12 device, unless halide_buffer_t has no associated resource. If there is no device memory (device field is NULL), returns 0.

◆ halide_d3d12compute_acquire_context()

int halide_d3d12compute_acquire_context ( void *  user_context,
struct halide_d3d12compute_device **  device_ret,
struct halide_d3d12compute_command_queue **  queue_ret,
bool  create 
)

This prototype is exported as applications will typically need to replace it to get Halide filters to execute on the same device and command queue used for other purposes.

The halide_d3d12compute_device is an ID3D12Device and halide_d3d12compute_command_queue is an ID3D12CommandQueue. No reference counting is done by Halide on these objects. They must remain valid until all off the following are true:

  • A balancing halide_d3d12compute_release_context has occurred for each halide_d3d12compute_acquire_context which returned the device/queue
  • All Halide filters using the context information have completed
  • All halide_buffer_t objects on the device have had halide_device_free called or have been detached via halide_d3d12compute_detach_buffer.
  • halide_device_release has been called on the interface returned from halide_d3d12compute_device_interface(). (This releases the programs on the context.)

◆ halide_d3d12compute_release_context()

int halide_d3d12compute_release_context ( void *  user_context)

This call balances each successfull halide_d3d12compute_acquire_context call.

If halide_d3d12compute_acquire_context is replaced, this routine must be replaced as well.