Shader Extension Proposal

CMakeLists.txt

@@ -44,6 +44,9 @@ add_definitions(
 	-DFNA3D_DRIVER_VULKAN
 	-DFNA3D_DRIVER_OPENGL
 )
+if(BUILD_SDL3)
+	add_definitions(-DFNA3D_DRIVER_SDL)
+endif()
 add_definitions(
 	-DMOJOSHADER_NO_VERSION_INCLUDE
 	-DMOJOSHADER_USE_SDL_STDLIB
@@ -101,6 +104,7 @@ add_library(FNA3D
 	src/FNA3D.c
 	src/FNA3D_Driver_D3D11.c
 	src/FNA3D_Driver_OpenGL.c
+	src/FNA3D_Driver_SDL.c
 	src/FNA3D_Driver_Vulkan.c
 	src/FNA3D_Image.c
 	src/FNA3D_CommandBuffer.c

include/FNA3D.h

@@ -166,7 +166,8 @@ typedef enum FNA3D_CubeMapFace
 typedef enum FNA3D_BufferUsage
 {
 	FNA3D_BUFFERUSAGE_NONE,
-	FNA3D_BUFFERUSAGE_WRITEONLY
+	FNA3D_BUFFERUSAGE_WRITEONLY,
+	FNA3D_BUFFERUSAGE_COMPUTE_EXT /* SDL shader extension only */
 } FNA3D_BufferUsage;
 
 typedef enum FNA3D_SetDataOptions
@@ -302,6 +303,14 @@ typedef enum FNA3D_VertexElementUsage
 	FNA3D_VERTEXELEMENTUSAGE_TESSELATEFACTOR
 } FNA3D_VertexElementUsage;
 
+typedef enum FNA3D_TextureUsageFlagBits
+{
+	FNA3D_TEXTUREUSAGE_RENDERTARGET_BIT           = 0x00000001,
+	FNA3D_TEXTUREUSAGE_COMPUTE_BIT                = 0x00000002,
+} FNA3D_TextureUsageFlagBits;
+
+typedef uint8_t FNA3D_TextureUsageFlags;
+
 /* Structures, should match XNA 4.0 */
 
 typedef struct FNA3D_Color
@@ -465,6 +474,20 @@ typedef struct FNA3D_RenderTargetBinding
 	FNA3D_Renderbuffer *colorBuffer;
 } FNA3D_RenderTargetBinding;
 
+typedef struct FNA3D_ComputeBufferBindingEXT
+{
+	FNA3D_Buffer *buffer;
+	int32_t cycle;
+} FNA3D_ComputeBufferBindingEXT;
+
+typedef struct FNA3D_ComputeTextureBindingEXT
+{
+	FNA3D_Texture *texture;
+	uint32_t mipLevel;
+	uint32_t layer;
+	int32_t cycle;
+} FNA3D_ComputeTextureBindingEXT;
+
 /* Version API */
 
 #define FNA3D_ABI_VERSION	 0
@@ -888,7 +911,8 @@ FNA3DAPI int32_t FNA3D_GetBackbufferMultiSampleCount(FNA3D_Device *device);
  * width:		The width of the texture image.
  * height:		The height of the texture image.
  * levelCount:		The number of mipmap levels to allocate.
- * isRenderTarget:	Set this to 1 when using this with SetRenderTargets.
+ * usageFlags:	Must have RENDERTARGET_BIT when using with SetRenderTargets.
+ * 				Must have COMPUTE_BIT when using with BindComputeTexturesEXT.
  *
  * Returns an allocated FNA3D_Texture* object. Note that the contents of the
  * texture are undefined, so you must call SetData at least once before drawing!
@@ -899,7 +923,7 @@ FNA3DAPI FNA3D_Texture* FNA3D_CreateTexture2D(
 	int32_t width,
 	int32_t height,
 	int32_t levelCount,
-	uint8_t isRenderTarget
+	FNA3D_TextureUsageFlags usageFlags
 );
 
 /* Creates a 3D texture to be applied to VerifySampler.
@@ -927,7 +951,8 @@ FNA3DAPI FNA3D_Texture* FNA3D_CreateTexture3D(
  * format:		The pixel format of the texture data.
  * size:		The length of a single edge of the texture cube.
  * levelCount:		The number of mipmap levels to allocate.
- * isRenderTarget:	Set this to 1 when using this with SetRenderTargets.
+ * usageFlags:	Must have RENDERTARGET_BIT when using with SetRenderTargets.
+ * 				Must have COMPUTE_BIT when using with BindComputeTexturesEXT.
  *
  * Returns an allocated FNA3D_Texture* object. Note that the contents of the
  * texture are undefined, so you must call SetData at least once before drawing!
@@ -937,7 +962,7 @@ FNA3DAPI FNA3D_Texture* FNA3D_CreateTextureCube(
 	FNA3D_SurfaceFormat format,
 	int32_t size,
 	int32_t levelCount,
-	uint8_t isRenderTarget
+	FNA3D_TextureUsageFlags usageFlags
 );
 
 /* Sends a texture to be destroyed by the renderer. Note that we call it
@@ -1538,6 +1563,112 @@ FNA3DAPI void FNA3D_SetStringMarker(FNA3D_Device *device, const char *text);
  */
 FNA3DAPI void FNA3D_SetTextureName(FNA3D_Device *device, FNA3D_Texture *texture, const char *text);
 
+/* Shader Extension
+ *
+ * These functions are ONLY valid with the SDL backend.
+ */
+
+typedef struct SDL_GpuGraphicsShaderInfo SDL_GpuGraphicsShaderInfo;
+typedef struct SDL_GpuComputeShaderInfo SDL_GpuComputeShaderInfo;
+typedef struct SDL_GpuComputeBufferBinding SDL_GpuComputeBufferBinding;
+typedef struct SDL_GpuComputeTextureBinding SDL_GpuComputeTextureBinding;
+
+/* Binds a vertex-fragment shader pair to be used with draw calls.
+ * If you call ApplyEffect, the shaders will be treated as unbound
+ * and it will become invalid to call any of the graphics shader EXT functions.
+ *
+ * vertShaderInfo: A struct containing the vertex shader module to bind and relevant metadata.
+ * fragShaderInfo: A struct containing the fragment shader module to bind and relevant metadata.
+ */
+FNA3DAPI void FNA3D_BindGraphicsShadersEXT(
+	FNA3D_Device *device,
+	SDL_GpuGraphicsShaderInfo *vertShaderInfo,
+	SDL_GpuGraphicsShaderInfo *fragShaderInfo
+);
+
+/* Pushes vertex uniform data to be used with subsequent draw calls.
+ * You may only call this after FNA3D_BindGraphicsShadersEXT has been called.
+ *
+ * data: client data to write into the uniform buffer
+ * dataLengthInBytes: the length of the client data to write
+ */
+FNA3DAPI void FNA3D_PushVertexShaderUniformsEXT(
+	FNA3D_Device *device,
+	void *data,
+	uint32_t dataLengthInBytes
+);
+
+/* Pushes fragment uniform data to be used with subsequent draw calls.
+ * You may only call this after FNA3D_BindGraphicsShadersEXT has been called.
+ *
+ * data: client data to write into the uniform buffer
+ * dataLengthInBytes: the length of the client data to write
+ */
+FNA3DAPI void FNA3D_PushFragmentShaderUniformsEXT(
+	FNA3D_Device *device,
+	void *data,
+	uint32_t dataLengthInBytes
+);
+
+/* Binds a compute shader to be used with compute dispatch calls.
+ * Note that this will break the render pass and unbind the graphics shaders,
+ * so interleaving this with draw calls will have bad performance.
+ *
+ * computeShaderInfo: A struct containing the compute shader module to bind and relevant metadata.
+ */
+FNA3DAPI void FNA3D_BindComputeShaderEXT(
+	FNA3D_Device *device,
+	SDL_GpuComputeShaderInfo *computeShaderInfo
+);
+
+/* Binds buffers for use with the bound compute pipeline.
+ * You may only call this function after FNA3D_BindComputeShaderEXT has been called.
+ *
+ * pBindings: An array of structs containing buffer and cycle option pairs.
+ *            Must be at least as long as the buffer bindings specified in the compute shader.
+ */
+FNA3DAPI void FNA3D_BindComputeBuffersEXT(
+	FNA3D_Device *device,
+	FNA3D_ComputeBufferBindingEXT *pBindings
+);
+
+/* Binds textures for use with the bound compute pipeline.
+ * You may only call this function after FNA3D_BindComputeShaderEXT has been called.
+ *
+ * pBindings: An array of structs containing texture and cycle option pairs.
+ *            Must be at least as long as the texture bindings specified in the compute shader.
+ */
+FNA3DAPI void FNA3D_BindComputeTexturesEXT(
+	FNA3D_Device *device,
+	FNA3D_ComputeTextureBindingEXT *pBindings
+);
+
+/* Pushes compute uniform data to be used with subsequent compute dispatches.
+ * You may only call this after FNA3D_BindComputeShaderEXT has been called.
+ *
+ * data: client data to write into the uniform buffer
+ * dataLengthInBytes: the length of the client data to write
+ */
+FNA3DAPI void FNA3D_PushComputeShaderUniformsEXT(
+	FNA3D_Device *device,
+	void *data,
+	uint32_t dataLengthInBytes
+);
+
+/* Dispatches compute work.
+ * You may only call this after FNA3D_BindComputeShaderEXT has been called.
+ *
+ * groupCountX: number of local workgroups to dispatch in the X dimension
+ * groupCountY: number of local workgroups to dispatch in the Y dimension
+ * groupCountZ: number of local workgroups to dispatch in the Z dimension
+ */
+FNA3DAPI void FNA3D_DispatchComputeEXT(
+	FNA3D_Device *device,
+	uint32_t groupCountX,
+	uint32_t groupCountY,
+	uint32_t groupCountZ
+);
+
 #ifdef __cplusplus
 }
 #endif /* __cplusplus */

src/FNA3D.c

@@ -40,6 +40,9 @@
 /* Drivers */
 
 static const FNA3D_Driver *drivers[] = {
+#if FNA3D_DRIVER_SDL
+	&SDLGPUDriver,
+#endif
 #if FNA3D_DRIVER_D3D11
 	&D3D11Driver,
 #endif
@@ -627,7 +630,7 @@ FNA3D_Texture* FNA3D_CreateTexture2D(
 	int32_t width,
 	int32_t height,
 	int32_t levelCount,
-	uint8_t isRenderTarget
+	FNA3D_TextureUsageFlags usageFlags
 ) {
 	/* We're stuck tracing _after_ the call instead of _before_, because
 	 * of threading issues. This can cause timing issues!
@@ -643,7 +646,7 @@ FNA3D_Texture* FNA3D_CreateTexture2D(
 		width,
 		height,
 		levelCount,
-		isRenderTarget
+		usageFlags
 	);
 	TRACE_CREATETEXTURE2D
 	return result;
@@ -682,7 +685,7 @@ FNA3D_Texture* FNA3D_CreateTextureCube(
 	FNA3D_SurfaceFormat format,
 	int32_t size,
 	int32_t levelCount,
-	uint8_t isRenderTarget
+	FNA3D_TextureUsageFlags usageFlags
 ) {
 	/* We're stuck tracing _after_ the call instead of _before_, because
 	 * of threading issues. This can cause timing issues!
@@ -697,7 +700,7 @@ FNA3D_Texture* FNA3D_CreateTextureCube(
 		format,
 		size,
 		levelCount,
-		isRenderTarget
+		usageFlags
 	);
 	TRACE_CREATETEXTURECUBE
 	return result;
@@ -1530,4 +1533,128 @@ FNA3D_Texture* FNA3D_CreateSysTextureEXT(
 	);
 }
 
+void FNA3D_BindGraphicsShadersEXT(
+	FNA3D_Device *device,
+	SDL_GpuGraphicsShaderInfo *vertShaderInfo,
+	SDL_GpuGraphicsShaderInfo *fragShaderInfo
+) {
+	if (device == NULL)
+	{
+		return;
+	}
+	device->BindGraphicsShadersEXT(
+		device->driverData,
+		vertShaderInfo,
+		fragShaderInfo
+	);
+}
+
+void FNA3D_PushVertexShaderUniformsEXT(
+	FNA3D_Device *device,
+	void *data,
+	uint32_t dataLengthInBytes
+) {
+	if (device == NULL)
+	{
+		return;
+	}
+	device->PushVertexShaderUniformsEXT(
+		device->driverData,
+		data,
+		dataLengthInBytes
+	);
+}
+
+void FNA3D_PushFragmentShaderUniformsEXT(
+	FNA3D_Device *device,
+	void *data,
+	uint32_t dataLengthInBytes
+) {
+	if (device == NULL)
+	{
+		return;
+	}
+	device->PushFragmentShaderUniformsEXT(
+		device->driverData,
+		data,
+		dataLengthInBytes
+	);
+}
+
+void FNA3D_BindComputeShaderEXT(
+	FNA3D_Device *device,
+	SDL_GpuComputeShaderInfo *computeShaderInfo
+) {
+	if (device == NULL)
+	{
+		return;
+	}
+	device->BindComputeShaderEXT(
+		device->driverData,
+		computeShaderInfo
+	);
+}
+
+void FNA3D_BindComputeBuffersEXT(
+	FNA3D_Device *device,
+	FNA3D_ComputeBufferBindingEXT *pBindings
+) {
+	if (device == NULL)
+	{
+		return;
+	}
+	device->BindComputeBuffersEXT(
+		device->driverData,
+		pBindings
+	);
+}
+
+void FNA3D_BindComputeTexturesEXT(
+	FNA3D_Device *device,
+	FNA3D_ComputeTextureBindingEXT *pBindings
+) {
+	if (device == NULL)
+	{
+		return;
+	}
+	device->BindComputeTexturesEXT(
+		device->driverData,
+		pBindings
+	);
+}
+
+void FNA3D_PushComputeShaderUniformsEXT(
+	FNA3D_Device *device,
+	void *data,
+	uint32_t dataLengthInBytes
+) {
+	if (device == NULL)
+	{
+		return;
+	}
+	device->PushComputeShaderUniformsEXT(
+		device->driverData,
+		data,
+		dataLengthInBytes
+	);
+}
+
+void FNA3D_DispatchComputeEXT(
+	FNA3D_Device *device,
+	uint32_t groupCountX,
+	uint32_t groupCountY,
+	uint32_t groupCountZ
+) {
+	if (device == NULL)
+	{
+		return;
+	}
+	device->DispatchComputeEXT(
+		device->driverData,
+		groupCountX,
+		groupCountY,
+		groupCountZ
+	);
+}
+
 /* vim: set noexpandtab shiftwidth=8 tabstop=8: */