diff --git a/Sources/kinc/graphics4/rendertarget.h b/Sources/kinc/graphics4/rendertarget.h index 1a41386d1..d48fb7587 100644 --- a/Sources/kinc/graphics4/rendertarget.h +++ b/Sources/kinc/graphics4/rendertarget.h @@ -38,7 +38,7 @@ typedef struct kinc_g4_render_target { } kinc_g4_render_target_t; /// -/// Allocates and initializes a regular render-target. +/// Allocates and initializes a regular render-target. The contents of the render-target are undefined. /// /// /// @@ -50,7 +50,8 @@ KINC_FUNC void kinc_g4_render_target_init(kinc_g4_render_target_t *renderTarget, int depthBufferBits, int stencilBufferBits); /// -/// Allocates and initializes a multi-sampled render-target if possible - otherwise it falls back to a regular render-target. +/// Allocates and initializes a multi-sampled render-target if possible - otherwise it falls back to a regular render-target. The contents of the render-target +/// are undefined. /// /// /// @@ -64,7 +65,7 @@ KINC_FUNC void kinc_g4_render_target_init_with_multisampling(kinc_g4_render_targ int samples_per_pixel); /// -/// Allocates and initializes a render-target-cube-map. +/// Allocates and initializes a render-target-cube-map. The contents of the render-target are undefined. /// /// /// @@ -75,7 +76,8 @@ KINC_FUNC void kinc_g4_render_target_init_cube(kinc_g4_render_target_t *renderTa int depthBufferBits, int stencilBufferBits); /// -/// Allocates and initializes a multi-sampled render-target-cube-map. Can fall back to a non-multi-sampled cube-map. +/// Allocates and initializes a multi-sampled render-target-cube-map. Can fall back to a non-multi-sampled cube-map. The contents of the render-target are +/// undefined. /// /// /// diff --git a/Sources/kinc/graphics5/rendertarget.h b/Sources/kinc/graphics5/rendertarget.h index b9f736a1b..c3cf2dc22 100644 --- a/Sources/kinc/graphics5/rendertarget.h +++ b/Sources/kinc/graphics5/rendertarget.h @@ -36,7 +36,7 @@ typedef struct kinc_g5_render_target { } kinc_g5_render_target_t; /// -/// Allocates and initializes a regular render-target. +/// Allocates and initializes a regular render-target. The contents of the render-target are undefined. /// /// /// @@ -49,7 +49,7 @@ KINC_FUNC void kinc_g5_render_target_init(kinc_g5_render_target_t *target, int w int stencilBufferBits); /// -/// Allocates and initializes a regular render-target. Can fall back to a regular render-target. +/// Allocates and initializes a regular render-target. Can fall back to a regular render-target. The contents of the render-target are undefined. /// /// /// @@ -63,7 +63,7 @@ KINC_FUNC void kinc_g5_render_target_init_with_multisampling(kinc_g5_render_targ int depthBufferBits, int stencilBufferBits, int samples_per_pixel); /// -/// Allocates and initializes a framebuffer. +/// Allocates and initializes a framebuffer. The contents of the framebuffer are undefined. /// /// /// @@ -76,7 +76,7 @@ KINC_FUNC void kinc_g5_render_target_init_framebuffer(kinc_g5_render_target_t *t int depthBufferBits, int stencilBufferBits); /// -/// Allocates and initializes a multisampled framebuffer. Can fall back to a regular framebuffer. +/// Allocates and initializes a multisampled framebuffer. Can fall back to a regular framebuffer. The contents of the framebuffer are undefined. /// /// /// @@ -91,7 +91,7 @@ KINC_FUNC void kinc_g5_render_target_init_framebuffer_with_multisampling(kinc_g5 int samples_per_pixel); /// -/// Allocates and initializes a render-target-cube-map. +/// Allocates and initializes a render-target-cube-map. The contents of the render-target are undefined. /// /// /// @@ -103,7 +103,7 @@ KINC_FUNC void kinc_g5_render_target_init_cube(kinc_g5_render_target_t *target, int stencilBufferBits); /// -/// Allocates and initializes a multisampled render-target-cube-map. Can fall back to a regular cube-map. +/// Allocates and initializes a multisampled render-target-cube-map. Can fall back to a regular cube-map. The contents of the render-target are undefined. /// /// ///