Cross platform texture writing

Now queue has a writeTexture method which uses the information from the
texture descriptor so you don't have to provide as much info at runtime.

This behaves like newer rendering APIs, so textures cannot be written to
in other formats for example with automatic conversions.

As a consequence, the texture manager now only accepts rgba8 format
images. But it seems like everything was already using that beyond the
white default texture which was easy to port over.

Author: codebycruz

packages/arisu-gfx/command_buffer/gl.lua

@@ -143,8 +143,9 @@ function GLCommandBuffer:execute()
 			vao:setIndexBuffer(command.buffer)
 			indexType = indexFormatToGL[command.format]
 		elseif command.type == "writeBuffer" then
-			local buffer = command.buffer --[[@as gfx.gl.Buffer]]
-			buffer:setSlice(command.size, command.data, command.offset)
+			command.buffer:setSlice(command.size, command.data, command.offset)
+		elseif command.type == "writeTexture" then
+			command.texture:writeData(command.descriptor, command.data)
 		elseif command.type == "setBindGroup" then
 			for _, entry in ipairs(command.bindGroup.entries) do
 				if entry.type == "buffer" then

packages/arisu-gfx/command_encoder.lua

@@ -1,3 +1,13 @@
+---@class gfx.TextureDataDescriptor
+---@field width number
+---@field height number
+---@field depth number? # For 3D textures
+---@field mip number?
+---@field layer number?
+---@field offset number?
+---@field bytesPerRow number?
+---@field rowsPerImage number?
+
 ---@alias gfx.LoadOp
 --- | { type: "clear", color: gfx.Color }
 --- | { type: "load" }
@@ -21,6 +31,7 @@
 ---@field draw fun(self: gfx.CommandEncoder, vertexCount: number, instanceCount: number, firstVertex: number?, firstInstance: number?)
 ---@field drawIndexed fun(self: gfx.CommandEncoder, indexCount: number, instanceCount: number, firstIndex: number?, baseVertex: number?, firstInstance: number?)
 ---@field writeBuffer fun(self: gfx.CommandEncoder, buffer: gfx.Buffer, size: number, data: ffi.cdata*, offset: number?)
+---@field writeTexture fun(self: gfx.CommandEncoder, texture: gfx.Texture, descriptor: gfx.TextureDataDescriptor, data: ffi.cdata*)
 local Encoder = require("arisu-gfx.encoder.gl") --[[@as gfx.CommandEncoder]]
 
 return Encoder

packages/arisu-gfx/command_encoder/gl.lua

@@ -11,6 +11,7 @@ local GLCommandBuffer = require("arisu-gfx.command_buffer.gl")
 ---| { type: "draw", vertexCount: number, instanceCount: number, firstVertex: number, firstInstance: number }
 ---| { type: "drawIndexed", indexCount: number, instanceCount: number, firstIndex: number, baseVertex: number, firstInstance: number }
 ---| { type: "writeBuffer", buffer: gfx.gl.Buffer, size: number, data: ffi.cdata*, offset: number }
+---| { type: "writeTexture", texture: gfx.gl.Texture, descriptor: gfx.TextureDataDescriptor, data: ffi.cdata* }
 
 ---@class gfx.gl.Encoder
 ---@field commands gfx.gl.Command[]
@@ -106,6 +107,18 @@ function GLCommandEncoder:writeBuffer(buffer, size, data, offset)
 	}
 end
 
+---@param texture gfx.gl.Texture
+---@param descriptor gfx.TextureDataDescriptor
+---@param data ffi.cdata*
+function GLCommandEncoder:writeTexture(texture, descriptor, data)
+	self.commands[#self.commands + 1] = {
+		type = "writeTexture",
+		texture = texture,
+		descriptor = descriptor,
+		data = data
+	}
+end
+
 function GLCommandEncoder:finish()
 	return GLCommandBuffer.new(self.commands)
 end

packages/arisu-gfx/queue.lua

@@ -1,6 +1,7 @@
 ---@class gfx.Queue
 ---@field submit fun(self: gfx.Queue, commandBuffer: gfx.CommandBuffer)
 ---@field writeBuffer fun(self: gfx.Queue, buffer: gfx.Buffer, size: number, data: ffi.cdata*, offset: number?)
+---@field writeTexture fun(self: gfx.Queue, texture: gfx.Texture, descriptor: gfx.TextureDataDescriptor, data: ffi.cdata*)
 local Queue = require("arisu-gfx.queue.gl") --[[@as gfx.Queue]]
 
 return Queue

packages/arisu-gfx/queue/gl.lua

@@ -27,4 +27,14 @@ function GLQueue:writeBuffer(buffer, size, data, offset)
 	self:submit(cmd:finish())
 end
 
+--- Helper method to write data to a texture
+---@param texture gfx.gl.Texture
+---@param descriptor gfx.TextureDataDescriptor
+---@param data ffi.cdata*
+function GLQueue:writeTexture(texture, descriptor, data)
+	local cmd = GLCommandEncoder.new()
+	cmd:writeTexture(texture, descriptor, data)
+	self:submit(cmd:finish())
+end
+
 return GLQueue

packages/arisu-gfx/texture/gl.lua

@@ -5,19 +5,28 @@ local gfx = require("arisu-gfx")
 ---@field framebuffer number
 ---@field id number? # if nil, it is the backbuffer (default framebuffer)
 ---@field context gfx.gl.Context? # only present if id is nil
+---@field private descriptor gfx.TextureDescriptor
 local GLTexture = {}
 GLTexture.__index = GLTexture
 
-local formatMap = {
+local glInternalFormatMap = {
 	[gfx.TextureFormat.Rgba8UNorm] = gl.RGBA8,
 }
 
+local glFormatMap = {
+	[gfx.TextureFormat.Rgba8UNorm] = gl.RGBA,
+}
+
+local glTypeMap = {
+	[gfx.TextureFormat.Rgba8UNorm] = gl.UNSIGNED_BYTE,
+}
+
 ---@param device gfx.gl.Device
 ---@param descriptor gfx.TextureDescriptor
 function GLTexture.new(device, descriptor)
 	local levels = descriptor.mipLevelCount or 1
 	local extents = descriptor.extents
-	local format = assert(formatMap[descriptor.format], "Unsupported texture format")
+	local format = assert(glInternalFormatMap[descriptor.format], "Unsupported texture format")
 
 	local id ---@type number
 	if extents.dim == "1d" then
@@ -45,7 +54,52 @@ function GLTexture.new(device, descriptor)
 		error("Unsupported texture extents")
 	end
 
-	return setmetatable({ framebuffer = 0, id = id }, GLTexture)
+	return setmetatable({ framebuffer = 0, id = id, descriptor = descriptor }, GLTexture)
+end
+
+---@param desc gfx.TextureDataDescriptor
+---@param data ffi.cdata*
+function GLTexture:writeData(desc, data)
+	local extents = self.descriptor.extents
+	local mip = desc.mip or 0
+	local layer = desc.layer or 0
+
+	local format = assert(glFormatMap[self.descriptor.format], "Unsupported texture format")
+	local type = assert(glTypeMap[self.descriptor.format], "Unsupported texture format")
+
+	data = data + (desc.offset or 0)
+	local bytesPerRow = desc.bytesPerRow
+	local rowsPerImage = desc.rowsPerImage
+
+	local width = desc.width or extents.width
+	local height = desc.height or extents.height
+	local depth = desc.depth or extents.depth
+
+	gl.pixelStorei(gl.UNPACK_ALIGNMENT, 1)
+	gl.pixelStorei(gl.UNPACK_IMAGE_HEIGHT, rowsPerImage or 0)
+	gl.pixelStorei(gl.UNPACK_ROW_LENGTH, bytesPerRow and (bytesPerRow / 4) or 0)
+
+	if extents.dim == "1d" then
+		if extents.count then
+			gl.textureSubImage2D(self.id, mip, 0, layer, width, 1, format, type, data)
+		else
+			gl.textureSubImage1D(self.id, mip, 0, width, format, type, data)
+		end
+	elseif extents.dim == "2d" then
+		if extents.count then
+			gl.textureSubImage3D(self.id, mip, 0, 0, layer, width, height, 1, format, type, data)
+		else
+			gl.textureSubImage2D(self.id, mip, 0, 0, width, height, format, type, data)
+		end
+	elseif extents.dim == "3d" then
+		gl.textureSubImage3D(self.id, mip, 0, 0, 0, width, height, depth, format, type, data)
+	else
+		error("Unsupported texture extents")
+	end
+
+	gl.pixelStorei(gl.UNPACK_ALIGNMENT, 4)
+	gl.pixelStorei(gl.UNPACK_IMAGE_HEIGHT, 0)
+	gl.pixelStorei(gl.UNPACK_ROW_LENGTH, 0)
 end
 
 ---@param framebuffer number
@@ -61,6 +115,15 @@ function GLTexture.forContextViewport(context)
 end
 
 function GLTexture:destroy()
+	gl.deleteTextures({ self.id })
+end
+
+function GLTexture:__tostring()
+	if self.context then
+		return "GLBackbuffer(" .. tostring(self.context) .. ")"
+	end
+
+	return "GLTexture(" .. tostring(self.id) .. ")"
 end
 
 return GLTexture

packages/arisu-opengl/init.lua

@@ -75,6 +75,7 @@ local nonCoreFnDefs = {
 
 	glCreateTextures = "void(*)(GLenum, GLsizei, GLuint*)",
 	glTextureStorage1D = "void(*)(GLuint, GLsizei, GLenum, GLsizei)",
+	glTextureSubImage1D = "void(*)(GLuint, GLsizei, GLint, GLsizei, GLenum, GLenum, const void*)",
 	glTextureStorage2D = "void(*)(GLuint, GLsizei, GLenum, GLsizei, GLsizei)",
 	glTextureSubImage2D = "void(*)(GLuint, GLsizei, GLint, GLint, GLsizei, GLsizei, GLenum, GLenum, const void*)",
 	glTextureStorage3D = "void(*)(GLuint, GLsizei, GLenum, GLsizei, GLsizei, GLsizei)",
@@ -106,7 +107,7 @@ local nonCoreFnDefs = {
 	glIsVertexArray = "GLboolean(*)(GLuint)",
 	glIsBuffer = "GLboolean(*)(GLuint)",
 
-
+	glPixelStorei = "void(*)(GLenum, GLint)",
 }
 
 ---@type fun(name: string): function
@@ -256,6 +257,10 @@ return {
 	COLOR_ATTACHMENT0 = 0x8CE0,
 	FRAMEBUFFER_COMPLETE = 0x8CD5,
 
+	UNPACK_ALIGNMENT = 0x0CF5,
+	UNPACK_ROW_LENGTH = 0x0CF2,
+	UNPACK_IMAGE_HEIGHT = 0x806E,
+
 	--- @param type gl.ShaderType
 	--- @param src string
 	--- @return number
@@ -387,6 +392,9 @@ return {
 	---@type fun(texture: number, levels: number, internalformat: number, width: number)
 	textureStorage1D = C.glTextureStorage1D,
 
+	---@type fun(texture: number, level: number, xoffset: number, width: number, format: number, type: number, pixels: userdata)
+	textureSubImage1D = C.glTextureSubImage1D,
+
 	---@type fun(texture: number, levels: number, internalformat: number, width: number, height: number)
 	textureStorage2D = C.glTextureStorage2D,
 
@@ -403,8 +411,12 @@ return {
 	---@type fun(unit: number, texture: number)
 	bindTextureUnit = C.glBindTextureUnit,
 
-	---@type fun(n: number, textures: userdata)
-	deleteTextures = C.glDeleteTextures,
+	---@type fun(textures: number[])
+	deleteTextures = function(textures)
+		local n = #textures
+		local handle = ffi.new("GLuint[?]", n, textures)
+		C.glDeleteTextures(n, handle)
+	end,
 
 	---@type fun(target: number, index: number, buffer: number)
 	bindBufferBase = C.glBindBufferBase,
@@ -533,4 +545,7 @@ return {
 	isBuffer = function(id)
 		return C.glIsBuffer(id) ~= 0
 	end,
+
+	---@type fun(pname: number, param: number)
+	pixelStorei = C.glPixelStorei,
 }

packages/arisu-util/init.lua

@@ -26,6 +26,39 @@ do
 	end
 end
 
+---@param done table<any, number>
+local function stringify(val, depth, done)
+	if done[val] then
+		return "<self " .. done[val] .. ">"
+	end
+
+	local ty = type(val)
+	if ty == "table" then
+		local out = { "{" }
+		local indent = string.rep("    ", depth + 1)
+
+		done[val] = depth
+		for k, v in pairs(val) do
+			local key = stringify(k, depth + 1, done)
+			local value = stringify(v, depth + 1, done)
+
+			out[#out + 1] = indent .. "[" .. key .. "] = " .. value .. ","
+		end
+		done[val] = nil
+
+		out[#out + 1] = string.sub(indent, 1, -4) .. "}"
+		return table.concat(out, "\n")
+	elseif ty == "string" then
+		return string.format("%q", val)
+	else
+		return tostring(val)
+	end
+end
+
+function util.dbg(val)
+	print(stringify(val, 0, {}))
+end
+
 function util.isWindows()
 	return ffi.os == "Windows"
 end

packages/arisu/gl/texture_manager.lua

@@ -56,7 +56,7 @@ function TextureManager.new(device)
 		textures = {},
 	}, TextureManager)
 
-	this.whiteTexture = this:upload(Image.new(1, 1, 3, ffi.new("uint8_t[?]", 3, { 255, 255, 255 }), ""))
+	this.whiteTexture = this:upload(Image.new(1, 1, 4, ffi.new("uint8_t[?]", 3, { 255, 255, 255, 255 }), ""))
 	this.errorTexture = this:upload(Image.new(
 		2,
 		2,
@@ -135,31 +135,12 @@ end
 function TextureManager:update(texture, image)
 	assert(self.textures[texture], "Texture does not exist")
 
-	local format = ({
-		[2] = gl.RG,
-		[3] = gl.RGB,
-		[4] = gl.RGBA,
-	})[image.channels]
-
-	assert(format, "Unsupported number of channels: " .. tostring(image.channels))
-
 	-- Update dimensions
 	local dims = ffi.new("float[4]", image.width, image.height, 0, 0)
 	self.device.queue:writeBuffer(self.textureDimsBuffer, 16, dims, texture * 16)
 
-	gl.textureSubImage3D(
-		self.texture.id,
-		0,
-		0,
-		0,
-		texture,
-		image.width,
-		image.height,
-		1,
-		format,
-		gl.UNSIGNED_BYTE,
-		image.pixels
-	)
+	self.device.queue:writeTexture(self.texture, { layer = texture, width = image.width, height = image.height },
+		image.pixels)
 end
 
 ---@param image Image