Skip to content

Commit

Permalink
Improve the documentation for set_image_texture
Browse files Browse the repository at this point in the history
  • Loading branch information
RobDangerous committed Aug 24, 2023
1 parent eecdddc commit 14ba508
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions Sources/kinc/graphics4/graphics.h
Original file line number Diff line number Diff line change
Expand Up @@ -357,14 +357,16 @@ KINC_FUNC void kinc_g4_set_render_targets(struct kinc_g4_render_target **targets
KINC_FUNC void kinc_g4_set_render_target_face(struct kinc_g4_render_target *texture, int face);

/// <summary>
/// Assigns a texture to a texture-unit for sampled access.
/// Assigns a texture to a texture-unit for sampled access via GLSL's texture.
/// </summary>
/// <param name="unit">The unit to assign this texture to</param>
/// <param name="texture">The texture to assign to the unit</param>
KINC_FUNC void kinc_g4_set_texture(kinc_g4_texture_unit_t unit, struct kinc_g4_texture *texture);

/// <summary>
/// Assigns a texture to a texture-unit for direct access.
/// Assigns a texture to a texture-unit for direct access via GLSL's texelFetch (as
/// opposed to GLSL's texture). The name of this functions is unfortunately based
/// on OpenGL's confusing terminology.
/// </summary>
/// <param name="unit">The unit to assign this texture to</param>
/// <param name="texture">The texture to assign to the unit</param>
Expand Down
6 changes: 4 additions & 2 deletions Sources/kinc/graphics5/commandlist.h
Original file line number Diff line number Diff line change
Expand Up @@ -273,15 +273,17 @@ KINC_FUNC void kinc_g5_command_list_get_render_target_pixels(kinc_g5_command_lis
KINC_FUNC void kinc_g5_command_list_compute(kinc_g5_command_list_t *list, int x, int y, int z);

/// <summary>
/// Assigns a texture to a texture-unit for sampled access.
/// Assigns a texture to a texture-unit for sampled access via GLSL's texture.
/// </summary>
/// <param name="list">The list to write the command to</param>
/// <param name="unit">The unit to assign this texture to</param>
/// <param name="texture">The texture to assign to the unit</param>
KINC_FUNC void kinc_g5_command_list_set_texture(kinc_g5_command_list_t *list, kinc_g5_texture_unit_t unit, kinc_g5_texture_t *texture);

/// <summary>
/// Assigns a texture to a texture-unit for direct access.
/// Assigns a texture to a texture-unit for direct access via GLSL's texelFetch (as
/// opposed to GLSL's texture). The name of this functions is unfortunately based
/// on OpenGL's confusing terminology.
/// </summary>
/// <param name="list">The list to write the command to</param>
/// <param name="unit">The unit to assign this texture to</param>
Expand Down

0 comments on commit 14ba508

Please sign in to comment.