dymokomi/luce-gpu
Source of release 0.5.3
0.5.3 / src / gpu / metal / texture.lucb
#==============================================================================================
#
# texture - Metal textures, uploads, readback and offscreen passes
#
# DESCRIPTION:
# Private-storage Metal textures. Uploads, copies and mipmaps are render passes in the
# device's open command buffer (metal/copies.lucb), ordered after earlier work; readbacks
# are metal/transfer.lucb's. An offscreen pass renders a canvas into the texture.
#
#==============================================================================================
struct MetalTexture:
var texture: void*?
var width: u32
var height: u32
var format: Format
extern func metal_copy_to_texture as "objc_msgSend"(object: void*, selector: void*, buffer: void*, offset: u64, bytes_per_row: u64, bytes_per_image: u64,
size: LuceGpuMetalExtent, texture: void*, slice: u64, level: u64, origin: LuceGpuMetalOrigin)
extern func metal_copy_from_texture as "objc_msgSend"(object: void*, selector: void*, texture: void*, slice: u64, level: u64, origin: LuceGpuMetalOrigin,
size: LuceGpuMetalExtent, buffer: void*, offset: u64, bytes_per_row: u64, bytes_per_image: u64)
extern func metal_new_buffer as "objc_msgSend"(object: void*, selector: void*, length: u64, options: u64) -> void*?
func metal_texture_create(device: MetalDevice*, width: u32, height: u32, pixel_format: Format, storage: bool, levels: u32 = 1) -> MetalTexture*!:
let pool = objc_autoreleasePoolPush()
defer objc_autoreleasePoolPop(pool)
let state = try new MetalTexture(width = width, height = height, format = pixel_format) in memory.heap
errdefer free(state) in memory.heap
let descriptor = metal_ptr(try metal_class("MTLTextureDescriptor"), metal_sel("new")) else error(failed, "could not create a GPU texture descriptor")
defer metal_void(descriptor, metal_sel("release"))
metal_uint_arg(descriptor, metal_sel("setTextureType:"), 2)
metal_uint_arg(descriptor, metal_sel("setPixelFormat:"), metal_pixel_format(pixel_format))
metal_uint_arg(descriptor, metal_sel("setWidth:"), (u64)width)
metal_uint_arg(descriptor, metal_sel("setHeight:"), (u64)height)
metal_uint_arg(descriptor, metal_sel("setMipmapLevelCount:"), (u64)levels)
# MTLStorageModePrivate; MTLTextureUsageShaderRead (1) and RenderTarget (4):
# uploads and copies render into every texture; ShaderWrite (2) for storage images.
metal_uint_arg(descriptor, metal_sel("setStorageMode:"), 2)
metal_uint_arg(descriptor, metal_sel("setUsage:"), 5u64 | (2u64 if storage else 0u64))
state.texture = metal_with_object(metal_required(device.device), metal_sel("newTextureWithDescriptor:"), descriptor) else error(out_of_memory, "could not allocate GPU texture storage")
return state
func metal_texture_destroy(state: MetalTexture*):
let pool = objc_autoreleasePoolPush()
defer objc_autoreleasePoolPop(pool)
if let texture = state.texture:
metal_void(texture, metal_sel("release"))
free(state) in memory.heap
## Uploads, copies and passes are encoded into the device's open command buffer
## (metal/submission.lucb), committed later without waiting. The queue runs work
## in order and a command buffer keeps what it uses alive, so later passes
## sampling this one's texture, and textures destroyed while it runs, need no
## wait: only a readback waits.
func metal_texture_upload(device: MetalDevice*, state: MetalTexture*, pixels: const u8[], region: Region) -> !:
let pool = objc_autoreleasePoolPush()
defer objc_autoreleasePoolPop(pool)
let row = (u64)region.width * (u64)texel_bytes(state.format)
let command = try metal_open(device)
# The bytes are copied into the upload ring, so the caller may reuse them at once.
let staged = try metal_ring_stage(device, pixels)
_ = row
try metal_copy_upload_texture(device, command, state, region, staged.buffer, staged.offset)
metal_encoded(device)
extern func metal_copy_texture as "objc_msgSend"(object: void*, selector: void*, source: void*, source_slice: u64, source_level: u64, origin: LuceGpuMetalOrigin,
size: LuceGpuMetalExtent, target: void*, target_slice: u64, target_level: u64, target_origin: LuceGpuMetalOrigin)
## Copy `region` of `source` to (`x`, `y`) of `target`, a render pass.
func metal_texture_copy(device: MetalDevice*, source: MetalTexture*, region: Region, target: MetalTexture*, x: u32, y: u32) -> !:
let pool = objc_autoreleasePoolPush()
defer objc_autoreleasePoolPop(pool)
try metal_copy_texture_pass(device, try metal_open(device), source, region, target, x, y)
metal_encoded(device)
## Fill the levels after the first, a render pass each from the level above.
func metal_texture_mipmaps(device: MetalDevice*, state: MetalTexture*) -> !:
let pool = objc_autoreleasePoolPush()
defer objc_autoreleasePoolPop(pool)
let levels = (u32)metal_uint(metal_required(state.texture), metal_sel("mipmapLevelCount"))
try metal_copy_mipmaps(device, try metal_open(device), state, levels)
metal_encoded(device)
func metal_texture_render(device: MetalDevice*, state: MetalTexture*, canvas: Canvas, color: Color, keep: bool) -> !:
let pool = objc_autoreleasePoolPush()
defer objc_autoreleasePoolPop(pool)
try metal_pass(device, try metal_open(device), metal_required(state.texture), metal_format_slot(state.format), canvas, color, (u64)state.width, (u64)state.height, keep)
metal_encoded(device)