cuda.bindings._v2.driver.array_3d_create_v2#

cuda.bindings._v2.driver.array_3d_create_v2(p_allocate_array) → intptr_t#

Creates a 3D CUDA array.

Creates a CUDA array according to the CUDA_ARRAY3D_DESCRIPTOR structure p_allocate_array and returns a handle to the new CUDA array in *p_handle. The CUDA_ARRAY3D_DESCRIPTOR is defined as:. **View CUDA Toolkit Documentation for a C++ code example**. where:.

Width, Height, and Depth are the width, height, and depth of the CUDA array (in elements); the following types of CUDA arrays can be allocated:.
A 1D array is allocated if Height and Depth extents are both zero.
A 2D array is allocated if only Depth extent is zero.
A 3D array is allocated if all three extents are non-zero.
A 1D layered CUDA array is allocated if only Height is zero and the CUDA_ARRAY3D_LAYERED flag is set. Each layer is a 1D array. The number of layers is determined by the depth extent.
A 2D layered CUDA array is allocated if all three extents are non-zero and the CUDA_ARRAY3D_LAYERED flag is set. Each layer is a 2D array. The number of layers is determined by the depth extent.
A cubemap CUDA array is allocated if all three extents are non-zero and the CUDA_ARRAY3D_CUBEMAP flag is set. Width must be equal to Height, and Depth must be six. A cubemap is a special type of 2D layered CUDA array, where the six layers represent the six faces of a cube. The order of the six layers in memory is the same as that listed in CUarray_cubemap_face.
A cubemap layered CUDA array is allocated if all three extents are non- zero, and both, CUDA_ARRAY3D_CUBEMAP and CUDA_ARRAY3D_LAYERED flags are set. Width must be equal to Height, and Depth must be a multiple of six. A cubemap layered CUDA array is a special type of 2D layered CUDA array that consists of a collection of cubemaps. The first six layers represent the first cubemap, the next six layers form the second cubemap, and so on.
Format specifies the format of the elements; CUarray_format is defined as:.
**View CUDA Toolkit Documentation for a C++ code example**.
NumChannels specifies the number of packed components per CUDA array element; it may be 1, 2, or 4;.
Flags may be set to.
CUDA_ARRAY3D_LAYERED to enable creation of layered CUDA arrays. If this flag is set, Depth specifies the number of layers, not the depth of a 3D array.
CUDA_ARRAY3D_SURFACE_LDST to enable surface references to be bound to the CUDA array. If this flag is not set, cuSurfRefSetArray will fail when attempting to bind the CUDA array to a surface reference.
CUDA_ARRAY3D_CUBEMAP to enable creation of cubemaps. If this flag is set, Width must be equal to Height, and Depth must be six. If the CUDA_ARRAY3D_LAYERED flag is also set, then Depth must be a multiple of six.
CUDA_ARRAY3D_TEXTURE_GATHER to indicate that the CUDA array will be used for texture gather. Texture gather can only be performed on 2D CUDA arrays.

Width, Height and Depth must meet certain size requirements as listed in the following table. All values are specified in elements. Note that for brevity’s sake, the full name of the device attribute is not specified. For ex., TEXTURE1D_WIDTH refers to the device attribute CU_DEVICE_ATTRIBUTE_MAXIMUM_TEXTURE1D_WIDTH. Note that 2D CUDA arrays have different size requirements if the CUDA_ARRAY3D_TEXTURE_GATHER flag is set. Width and Height must not be greater than CU_DEVICE_ATTRIBUTE_MAXIMUM_TEXTURE2D_GATHER_WIDTH and CU_DEVICE_ATTRIBUTE_MAXIMUM_TEXTURE2D_GATHER_HEIGHT respectively, in that case. **View CUDA Toolkit Documentation for a table example**. Here are examples of CUDA array descriptions:. Description for a CUDA array of 2048 floats:. **View CUDA Toolkit Documentation for a C++ code example**. Description for a 64 x 64 CUDA array of floats:. **View CUDA Toolkit Documentation for a C++ code example**. Description for a width x height x depth CUDA array of 64-bit, 4x16-bit float16’s:. **View CUDA Toolkit Documentation for a C++ code example**.

Parameters:: p_allocate_array (intptr_t) – 3D array descriptor.
Returns:: Returned array.
Return type:: intptr_t