Skip to content

Commit 6a36b3f

Browse files
committed
API docs: Clarify usage of projectm_set_window_size()
Calling the function with the same size again and again does not do anything at all - especially not "reset the renderer" as it was previously stated. Signed-off-by: Kai Blaschke <[email protected]>
1 parent 48ad458 commit 6a36b3f

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/api/include/projectM-4/parameters.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,11 @@ PROJECTM_EXPORT bool projectm_get_preset_locked(projectm_handle instance);
317317
/**
318318
* @brief Sets the current viewport size in pixels.
319319
*
320-
* Calling this function will reset the OpenGL renderer.
320+
* The internal textures will only be replaced and resized when rendering the next frame and only
321+
* if any of the two dimensions actually changed.
322+
*
323+
* Calling this function on every frame with the same size doesn't have any negative
324+
* effects as it only updates the size with the same values.
321325
*
322326
* @param instance The projectM instance handle.
323327
* @param width New viewport width in pixels.

0 commit comments

Comments
 (0)