|
Size: 703
Comment: update content - w/ Sam; remove draft
|
Size: 1039
Comment: affects the display, not the window
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| Use this function to get the brightness (gamma correction) for a window. | Use this function to get the brightness (gamma multiplier) for the display that owns the given window. |
| Line 15: | Line 15: |
| ||'''window'''||the window to query|| | ||'''window'''||the window used to select the display whose brightness will be queried|| |
| Line 18: | Line 18: |
| Returns the brightness for the window where 0.0 is completely dark and 1.0 is normal brightness. | Returns the brightness for the display where 0.0 is completely dark and 1.0 is normal brightness. |
| Line 26: | Line 26: |
| ''You can add useful comments here'' | Despite the name and signature, this method retrieves the brightness of the entire display, not an individual window. A window is considered to be owned by the display that contains the window's center pixel. (The index of this display can be retrieved using [[SDL_GetWindowDisplayIndex]].) |
SDL_GetWindowBrightness
Use this function to get the brightness (gamma multiplier) for the display that owns the given window.
Contents
Syntax
float SDL_GetWindowBrightness(SDL_Window* window)
Function Parameters
window |
the window used to select the display whose brightness will be queried |
Return Value
Returns the brightness for the display where 0.0 is completely dark and 1.0 is normal brightness.
Code Examples
You can add your code example here
Remarks
Despite the name and signature, this method retrieves the brightness of the entire display, not an individual window. A window is considered to be owned by the display that contains the window's center pixel. (The index of this display can be retrieved using SDL_GetWindowDisplayIndex.)
