mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2024-09-06 23:39:48 +00:00
parent 9730f62e8c
commit f42da35ef9
1 changed files with 37 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
include/SDL3/SDL_gpu.h
View File

@ -751,7 +751,8 @@ typedef enum SDL_GPUStencilOp
} SDL_GPUStencilOp;
/**
* Specifies the operator to be used when pixels in a render target are blended with existing pixels in the texture.
* Specifies the operator to be used when pixels in a render target are
* blended with existing pixels in the texture.
*
* The source color is the value written by the fragment shader. The
* destination color is the value currently existing in the texture.
@ -770,7 +771,8 @@ typedef enum SDL_GPUBlendOp
} SDL_GPUBlendOp;
/**
* Specifies a blending factor to be used when pixels in a render target are blended with existing pixels in the texture.
* Specifies a blending factor to be used when pixels in a render target are
* blended with existing pixels in the texture.
*
* The source color is the value written by the fragment shader. The
* destination color is the value currently existing in the texture.
@ -1540,7 +1542,8 @@ extern SDL_DECLSPEC SDL_GPUDriver SDLCALL SDL_GetGPUDriver(SDL_GPUDevice *device
* textures
*
* \param device a GPU Context.
* \param createinfo a struct describing the state of the compute pipeline to create.
* \param createinfo a struct describing the state of the compute pipeline to
* create.
* \returns a compute pipeline object on success, or NULL on failure.
*
* \since This function is available since SDL 3.0.0.
@ -1556,7 +1559,8 @@ extern SDL_DECLSPEC SDL_GPUComputePipeline *SDLCALL SDL_CreateGPUComputePipeline
* Creates a pipeline object to be used in a graphics workflow.
*
* \param device a GPU Context.
* \param createinfo a struct describing the state of the graphics pipeline to create.
* \param createinfo a struct describing the state of the graphics pipeline to
* create.
* \returns a graphics pipeline object on success, or NULL on failure.
*
* \since This function is available since SDL 3.0.0.
@ -1727,7 +1731,8 @@ extern SDL_DECLSPEC SDL_GPUBuffer *SDLCALL SDL_CreateGPUBuffer(
* graphics resources.
*
* \param device a GPU Context.
* \param createinfo a struct describing the state of the transfer buffer to create.
* \param createinfo a struct describing the state of the transfer buffer to
* create.
* \returns a transfer buffer on success, or NULL on failure.
*
* \since This function is available since SDL 3.0.0.
@ -2180,8 +2185,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUVertexBuffers(
* calls.
*
* \param render_pass a render pass handle.
* \param binding a pointer to a struct containing an index buffer and
* offset.
* \param binding a pointer to a struct containing an index buffer and offset.
* \param index_element_size whether the index values in the buffer are 16- or
* 32-bit.
*
@ -2199,7 +2203,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUIndexBuffer(
*
* \param render_pass a render pass handle.
* \param first_slot the vertex sampler slot to begin binding from.
* \param texture_sampler_bindings an array of texture-sampler binding structs.
* \param texture_sampler_bindings an array of texture-sampler binding
* structs.
* \param num_bindings the number of texture-sampler pairs to bind from the
* array.
*
@ -2256,7 +2261,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_BindGPUVertexStorageBuffers(
*
* \param render_pass a render pass handle.
* \param first_slot the fragment sampler slot to begin binding from.
* \param texture_sampler_bindings an array of texture-sampler binding structs.
* \param texture_sampler_bindings an array of texture-sampler binding
* structs.
* \param num_bindings the number of texture-sampler pairs to bind from the
* array.
*
@ -2372,8 +2378,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_DrawGPUPrimitives(
* \param render_pass a render pass handle.
* \param buffer a buffer containing draw parameters.
* \param offset the offset to start reading from the draw buffer.
* \param draw_count the number of draw parameter sets that should be read from
* the draw buffer.
* \param draw_count the number of draw parameter sets that should be read
* from the draw buffer.
* \param pitch the byte pitch between sets of draw parameters.
*
* \since This function is available since SDL 3.0.0.
@ -2396,8 +2402,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_DrawGPUPrimitivesIndirect(
* \param render_pass a render pass handle.
* \param buffer a buffer containing draw parameters.
* \param offset the offset to start reading from the draw buffer.
* \param draw_count the number of draw parameter sets that should be read from
* the draw buffer.
* \param draw_count the number of draw parameter sets that should be read
* from the draw buffer.
* \param pitch the byte pitch between sets of draw parameters.
*
* \since This function is available since SDL 3.0.0.
@ -2441,14 +2447,14 @@ extern SDL_DECLSPEC void SDLCALL SDL_EndGPURenderPass(
* you can safely access the data.
*
* \param command_buffer a command buffer.
* \param storage_texture_bindings an array of writeable storage texture binding
* structs.
* \param storage_texture_bindings an array of writeable storage texture
* binding structs.
* \param num_storage_texture_bindings the number of storage textures to bind
* from the array.
* \param storage_buffer_bindings an array of writeable storage buffer binding
* structs.
* \param num_storage_buffer_bindings the number of storage buffers to bind from
* the array.
* \param num_storage_buffer_bindings the number of storage buffers to bind
* from the array.
* \returns a compute pass handle.
*
* \since This function is available since SDL 3.0.0.