Skip to content

Commit

Permalink
Update BulbRenderer.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JujuAdams committed Sep 16, 2024
1 parent a37997a commit aeffc11
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/22.0/BulbRenderer.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,21 @@ Bulb uses gamma correct lighting and, as such, works in a slightly different way

!> Be careful not to draw a lit surface to itself! This can cause serious rendering errors.

?> If you'd like to draw the application surface, you'll probably find it easier to use `BulbDrawLitApplicationSurface()`.
?> This function is intended to be called in a Draw GUI event, though you're welcome to use it wherever. If you'd like to draw the application surface, you'll probably find it easier to use `BulbDrawLitApplicationSurface()`.

 

## .GetOutputSurface

`.GetOutputSurface(surface)`

**Returns:** Surface, containing a copy of the input surface but lit

|Argument |Datatype|Purpose |
|---------|--------|--------------------------------------------------|
|`surface`|surface |Surface to copy to the output surface for lighting|

This function returns a surface that is a copy of the input surface but lit up using the light accumulated by the renderer. The dimensions of the output surface will match the input surface. This function is similar to `.DrawLitSurface()` but doesn't do the drawing for you and is therefore helpful as a component of a post-processing pipeline.

 

Expand Down

0 comments on commit aeffc11

Please sign in to comment.