Wiki Page Content

Differences between revisions 7 and 8
Revision 7 as of 2011-05-17 17:40:43
Size: 909
Editor: SheenaSmith
Comment: minor change
Revision 8 as of 2014-06-23 22:33:33
Size: 1247
Editor: AdamMil
Comment: sets display brightness, not window brightness. gamma multplier, not gamma.
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
Use this function to set the brightness (gamma correction) for a window. Use this function to set the brightness (gamma multiplier) for the display that owns a given window.
Line 16: Line 16:
||'''window'''||the window to change||
||'''brightness'''||the brightness (gamma) value to set where 0.0 is completely dark and 1.0 is normal brightness||
||'''window'''||the window used to select the display whose brightness will be changed||
||'''brightness'''||the brightness (gamma multiplier) value to set where 0.0 is completely dark and 1.0 is normal brightness||
Line 28: Line 28:
''You can add useful comments here'' Despite the name and signature, this method sets 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_SetWindowBrightness

Use this function to set the brightness (gamma multiplier) for the display that owns a given window.

Syntax

int SDL_SetWindowBrightness(SDL_Window* window,
                            float       brightness)

Function Parameters

window

the window used to select the display whose brightness will be changed

brightness

the brightness (gamma multiplier) value to set where 0.0 is completely dark and 1.0 is normal brightness

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Code Examples

You can add your code example here

Remarks

Despite the name and signature, this method sets 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.)


CategoryAPI, CategoryVideo

None: SDL_SetWindowBrightness (last edited 2014-06-24 23:45:10 by PhilippWiesemann)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit