@@ -2245,9 +2245,11 @@ extern SDL_DECLSPEC SDL_GPUShaderFormat SDLCALL SDL_GetGPUShaderFormats(SDL_GPUD
2245
2245
* - [[texture]]: Sampled textures, followed by read-only storage textures,
2246
2246
* followed by read-write storage textures
2247
2247
*
2248
- * There are optional properties that can be provided through `props`. These are the supported properties:
2248
+ * There are optional properties that can be provided through `props`. These
2249
+ * are the supported properties:
2249
2250
*
2250
- * - `SDL_PROP_GPU_COMPUTEPIPELINE_CREATE_NAME_STRING`: a name that can be displayed in debugging tools.
2251
+ * - `SDL_PROP_GPU_COMPUTEPIPELINE_CREATE_NAME_STRING`: a name that can be
2252
+ * displayed in debugging tools.
2251
2253
*
2252
2254
* \param device a GPU Context.
2253
2255
* \param createinfo a struct describing the state of the compute pipeline to
@@ -2269,9 +2271,11 @@ extern SDL_DECLSPEC SDL_GPUComputePipeline *SDLCALL SDL_CreateGPUComputePipeline
2269
2271
/**
2270
2272
* Creates a pipeline object to be used in a graphics workflow.
2271
2273
*
2272
- * There are optional properties that can be provided through `props`. These are the supported properties:
2274
+ * There are optional properties that can be provided through `props`. These
2275
+ * are the supported properties:
2273
2276
*
2274
- * - `SDL_PROP_GPU_GRAPHICSPIPELINE_CREATE_NAME_STRING`: a name that can be displayed in debugging tools.
2277
+ * - `SDL_PROP_GPU_GRAPHICSPIPELINE_CREATE_NAME_STRING`: a name that can be
2278
+ * displayed in debugging tools.
2275
2279
*
2276
2280
* \param device a GPU Context.
2277
2281
* \param createinfo a struct describing the state of the graphics pipeline to
@@ -2295,9 +2299,11 @@ extern SDL_DECLSPEC SDL_GPUGraphicsPipeline *SDLCALL SDL_CreateGPUGraphicsPipeli
2295
2299
* Creates a sampler object to be used when binding textures in a graphics
2296
2300
* workflow.
2297
2301
*
2298
- * There are optional properties that can be provided through `props`. These are the supported properties:
2302
+ * There are optional properties that can be provided through `props`. These
2303
+ * are the supported properties:
2299
2304
*
2300
- * - `SDL_PROP_GPU_SAMPLER_CREATE_NAME_STRING`: a name that can be displayed in debugging tools.
2305
+ * - `SDL_PROP_GPU_SAMPLER_CREATE_NAME_STRING`: a name that can be displayed
2306
+ * in debugging tools.
2301
2307
*
2302
2308
* \param device a GPU Context.
2303
2309
* \param createinfo a struct describing the state of the sampler to create.
@@ -2373,9 +2379,11 @@ extern SDL_DECLSPEC SDL_GPUSampler *SDLCALL SDL_CreateGPUSampler(
2373
2379
* SDL_PROP_GPU_DEVICE_CREATE_D3D12_SEMANTIC_NAME_STRING with
2374
2380
* SDL_CreateGPUDeviceWithProperties().
2375
2381
*
2376
- * There are optional properties that can be provided through `props`. These are the supported properties:
2382
+ * There are optional properties that can be provided through `props`. These
2383
+ * are the supported properties:
2377
2384
*
2378
- * - `SDL_PROP_GPU_SHADER_CREATE_NAME_STRING`: a name that can be displayed in debugging tools.
2385
+ * - `SDL_PROP_GPU_SHADER_CREATE_NAME_STRING`: a name that can be displayed in
2386
+ * debugging tools.
2379
2387
*
2380
2388
* \param device a GPU Context.
2381
2389
* \param createinfo a struct describing the state of the shader to create.
@@ -2430,7 +2438,8 @@ extern SDL_DECLSPEC SDL_GPUShader *SDLCALL SDL_CreateGPUShader(
2430
2438
* - `SDL_PROP_GPU_CREATETEXTURE_D3D12_CLEAR_STENCIL_UINT8`: (Direct3D 12
2431
2439
* only) if the texture usage is SDL_GPU_TEXTUREUSAGE_DEPTH_STENCIL_TARGET,
2432
2440
* clear the texture to a stencil of this value. Defaults to zero.
2433
- * - `SDL_PROP_GPU_TEXTURE_CREATE_NAME_STRING`: a name that can be displayed in debugging tools.
2441
+ * - `SDL_PROP_GPU_TEXTURE_CREATE_NAME_STRING`: a name that can be displayed
2442
+ * in debugging tools.
2434
2443
*
2435
2444
* \param device a GPU Context.
2436
2445
* \param createinfo a struct describing the state of the texture to create.
@@ -2476,9 +2485,11 @@ extern SDL_DECLSPEC SDL_GPUTexture *SDLCALL SDL_CreateGPUTexture(
2476
2485
* [this blog post](https://moonside.games/posts/sdl-gpu-concepts-cycling/)
2477
2486
* .
2478
2487
*
2479
- * There are optional properties that can be provided through `props`. These are the supported properties:
2488
+ * There are optional properties that can be provided through `props`. These
2489
+ * are the supported properties:
2480
2490
*
2481
- * - `SDL_PROP_GPU_BUFFER_CREATE_NAME_STRING`: a name that can be displayed in debugging tools.
2491
+ * - `SDL_PROP_GPU_BUFFER_CREATE_NAME_STRING`: a name that can be displayed in
2492
+ * debugging tools.
2482
2493
*
2483
2494
* \param device a GPU Context.
2484
2495
* \param createinfo a struct describing the state of the buffer to create.
@@ -2513,9 +2524,11 @@ extern SDL_DECLSPEC SDL_GPUBuffer *SDLCALL SDL_CreateGPUBuffer(
2513
2524
* Download buffers can be particularly expensive to create, so it is good
2514
2525
* practice to reuse them if data will be downloaded regularly.
2515
2526
*
2516
- * There are optional properties that can be provided through `props`. These are the supported properties:
2527
+ * There are optional properties that can be provided through `props`. These
2528
+ * are the supported properties:
2517
2529
*
2518
- * - `SDL_PROP_GPU_TRANSFERBUFFER_CREATE_NAME_STRING`: a name that can be displayed in debugging tools.
2530
+ * - `SDL_PROP_GPU_TRANSFERBUFFER_CREATE_NAME_STRING`: a name that can be
2531
+ * displayed in debugging tools.
2519
2532
*
2520
2533
* \param device a GPU Context.
2521
2534
* \param createinfo a struct describing the state of the transfer buffer to
@@ -2542,13 +2555,15 @@ extern SDL_DECLSPEC SDL_GPUTransferBuffer *SDLCALL SDL_CreateGPUTransferBuffer(
2542
2555
/**
2543
2556
* Sets an arbitrary string constant to label a buffer.
2544
2557
*
2545
- * You should use SDL_PROP_GPU_BUFFER_CREATE_NAME_STRING with SDL_CreateGPUBuffer instead of this function to avoid thread safety issues.
2558
+ * You should use SDL_PROP_GPU_BUFFER_CREATE_NAME_STRING with
2559
+ * SDL_CreateGPUBuffer instead of this function to avoid thread safety issues.
2546
2560
*
2547
2561
* \param device a GPU Context.
2548
2562
* \param buffer a buffer to attach the name to.
2549
2563
* \param text a UTF-8 string constant to mark as the name of the buffer.
2550
2564
*
2551
- * \threadsafety This function is not thread safe, you must make sure the buffer is not simultaneously used by any other thread.
2565
+ * \threadsafety This function is not thread safe, you must make sure the
2566
+ * buffer is not simultaneously used by any other thread.
2552
2567
*
2553
2568
* \since This function is available since SDL 3.1.3.
2554
2569
*
@@ -2562,13 +2577,16 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetGPUBufferName(
2562
2577
/**
2563
2578
* Sets an arbitrary string constant to label a texture.
2564
2579
*
2565
- * You should use SDL_PROP_GPU_TEXTURE_CREATE_NAME_STRING with SDL_CreateGPUTexture instead of this function to avoid thread safety issues.
2580
+ * You should use SDL_PROP_GPU_TEXTURE_CREATE_NAME_STRING with
2581
+ * SDL_CreateGPUTexture instead of this function to avoid thread safety
2582
+ * issues.
2566
2583
*
2567
2584
* \param device a GPU Context.
2568
2585
* \param texture a texture to attach the name to.
2569
2586
* \param text a UTF-8 string constant to mark as the name of the texture.
2570
2587
*
2571
- * \threadsafety This function is not thread safe, you must make sure the texture is not simultaneously used by any other thread.
2588
+ * \threadsafety This function is not thread safe, you must make sure the
2589
+ * texture is not simultaneously used by any other thread.
2572
2590
*
2573
2591
* \since This function is available since SDL 3.1.3.
2574
2592
*
0 commit comments