All Implemented Interfaces:

java.lang.AutoCloseable
```
public abstract class Renderer
 implements AutoCloseable
                    
```
The renderer is responsible for drawing all components to the screen, handling frame buffers, and more. Please make sure to implement all the functions in this class, and you may want to familiarize yourself with how org.polyfrost.polyui.PolyUI works.
It is also responsible for loading and caching all images and fonts, but this is down to you as a rendering implementation to implement. for these functions, such as image and text, an initialized Font or PolyImage instance will be given. You can access the data using Resource.stream, and cache it for future use (ideally).

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Float`	`alphaCap`
`private final PolyUI`	`polyUI`
`private final Settings`	`settings`
`private final Float`	`pixelRatio`
`private Float`	`width`
`private Float`	`height`

Constructor Summary

Constructors
Constructor	Description
`Renderer(Float width, Float height)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Float`	`getAlphaCap()`	set a maximum alpha value for all future draw calls, in the range (0-1), until reset.
`final Unit`	`setAlphaCap(Float alphaCap)`	set a maximum alpha value for all future draw calls, in the range (0-1), until reset.
`final PolyUI`	`getPolyUI()`
`final Settings`	`getSettings()`
`final Float`	`getPixelRatio()`	the pixel ratio of the screen, used mainly on Apple screens which use high-dpi.
`Float`	`getWidth()`
`Unit`	`setWidth(Float width)`
`Float`	`getHeight()`
`Unit`	`setHeight(Float height)`
`final Unit`	`render(Function1<Renderer, Unit> block)`	hook into this renderer.
`abstract Unit`	`init()`	This function is called during very early initialization, and should be used to prepare the renderer for use.
`abstract Unit`	`beginFrame()`	Begin a frame.
`abstract Unit`	`endFrame()`	End a frame.
`final Unit`	`globalAlpha(Float alpha)`	Set the alpha for all future draw calls, in the range (0-1), until reset.
`final Unit`	`resetAlphaCap()`	reset the alphaCap.
`final Unit`	`resetGlobalAlpha()`	reset the global alpha to normal.
`abstract Unit`	`translate(Float x, Float y)`	translate the origin of all future draw calls by the given amount.
`abstract Unit`	`scale(Float x, Float y)`	scales all future draw calls by the given amount.
`abstract Unit`	`rotate(Double angleRadians)`	rotate all future draw calls by the given amount.
`abstract Unit`	`skewX(Double angleRadians)`	Skew all future draw calls by the given amount.
`abstract Unit`	`skewY(Double angleRadians)`	Skew all future draw calls by the given amount.
`abstract Unit`	`pushScissor(Float x, Float y, Float width, Float height)`	begin a scissor rectangle, that will clip rendering to the given rectangle.
`abstract Unit`	`pushScissorIntersecting(Float x, Float y, Float width, Float height)`	begin a scissor rectangle, that will clip rendering to the given rectangle.
`abstract Unit`	`popScissor()`	end a scissor.
`abstract Unit`	`push()`	Push the current state, saving all the current transforms before creating a new one with the same parameters as the current one.
`abstract Unit`	`pop()`	pop the current state, reverting all transforms to the previous values.
`abstract Unit`	`text(Font font, Float x, Float y, String text, Color color, Float fontSize)`	draw text to the screen, per the given parameters.
`abstract Vec2<Unit.Pixel>`	`textBounds(Font font, String text, Float fontSize)`	calculate the bounds of this text, per the given parameters.
`abstract Unit`	`initImage(PolyImage image)`	Function that can be called to explicitly initialize an image.
`abstract Unit`	`image(PolyImage image, Float x, Float y, Float width, Float height, Integer colorMask, Float topLeftRadius, Float topRightRadius, Float bottomLeftRadius, Float bottomRightRadius)`	Draw an image to the screen, per the given parameters.
`final Unit`	`image(PolyImage image, Float x, Float y, Float width, Float height, Float radius, Integer colorMask)`
`final Unit`	`image(PolyImage image, Float x, Float y, Float width, Float height, FloatArray radii, Integer colorMask)`
`abstract Unit`	`rect(Float x, Float y, Float width, Float height, Color color, Float topLeftRadius, Float topRightRadius, Float bottomLeftRadius, Float bottomRightRadius)`	draw a rectangle to the screen, per the given parameters.
`final Unit`	`rect(Float x, Float y, Float width, Float height, Color color, Float radius)`
`final Unit`	`rect(Float x, Float y, Float width, Float height, Color color, FloatArray radii)`
`abstract Unit`	`hollowRect(Float x, Float y, Float width, Float height, Color color, Float lineWidth, Float topLeftRadius, Float topRightRadius, Float bottomLeftRadius, Float bottomRightRadius)`	draw a hollow rectangle to the screen, per the given parameters.
`final Unit`	`hollowRect(Float x, Float y, Float width, Float height, Color color, Float lineWidth, Float radius)`
`final Unit`	`hollowRect(Float x, Float y, Float width, Float height, Color color, Float lineWidth, FloatArray radii)`
`Unit`	`circle(Float x, Float y, Float radius, Color color)`	Draw a circle to the screen, as per the given parameters.
`abstract Unit`	`line(Float x1, Float y1, Float x2, Float y2, Color color, Float width)`	Draws a line between two points with the specified color and width.
`abstract Unit`	`dropShadow(Float x, Float y, Float width, Float height, Float blur, Float spread, Float radius)`	Draw a drop shadow to the screen, per the given parameters.
`abstract Framebuffer`	`createFramebuffer(Float width, Float height)`	Create a new framebuffer.
`abstract Unit`	`bindFramebuffer(Framebuffer fbo)`	Bind the given framebuffer.
`abstract Unit`	`unbindFramebuffer(Framebuffer fbo)`	Unbind the given framebuffer.
`abstract Unit`	`drawFramebuffer(Framebuffer fbo, Float x, Float y, Float width, Float height)`	draw the given framebuffer to the screen.
`abstract Unit`	`delete(Framebuffer fbo)`	Delete the given framebuffer.
`abstract Unit`	`delete(Font font)`	Delete the given font.
`abstract Unit`	`delete(PolyImage image)`	Delete the given image.
`abstract Unit`	`cleanup()`	Cleanup the PolyUI instance.
`Unit`	`close()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Renderer
```
Renderer(Float width, Float height)
```
- Method Detail
  - getAlphaCap
```
 final Float getAlphaCap()
```
    set a maximum alpha value for all future draw calls, in the range (0-1), until reset. This is useful for fading in/out all of PolyUI, for example.
    Note that this itself will not set the global alpha, so use globalAlpha to do that.
  - setAlphaCap
```
 final Unit setAlphaCap(Float alphaCap)
```
    set a maximum alpha value for all future draw calls, in the range (0-1), until reset. This is useful for fading in/out all of PolyUI, for example.
    Note that this itself will not set the global alpha, so use globalAlpha to do that.
  - getPolyUI
```
 final PolyUI getPolyUI()
```
  - getSettings
```
 final Settings getSettings()
```
  - getPixelRatio
```
 final Float getPixelRatio()
```
    the pixel ratio of the screen, used mainly on Apple screens which use high-dpi.
  - getWidth
```
 Float getWidth()
```
  - setWidth
```
 Unit setWidth(Float width)
```
  - getHeight
```
 Float getHeight()
```
  - setHeight
```
 Unit setHeight(Float height)
```
  - render
```
 final Unit render(Function1<Renderer, Unit> block)
```
    hook into this renderer.
  - init
```
 abstract Unit init()
```
    This function is called during very early initialization, and should be used to prepare the renderer for use. This is always the first function called.
    
    Since:
    
    0.21.2
  - beginFrame
```
 abstract Unit beginFrame()
```
    Begin a frame. this is called before all drawing calls.
  - endFrame
```
 abstract Unit endFrame()
```
    End a frame. this is called after all drawing calls.
  - globalAlpha
```
 final Unit globalAlpha(Float alpha)
```
    Set the alpha for all future draw calls, in the range (0-1), until reset.
    Note that this call is capped by alphaCap, so if a value higher than alphaCap's value is set, it will just set it to that.
  - resetAlphaCap
```
 final Unit resetAlphaCap()
```
    reset the alphaCap. This is the same as doing alphaCap= 1f.
  - resetGlobalAlpha
```
 final Unit resetGlobalAlpha()
```
    reset the global alpha to normal.
    Respects the alphaCap, so may not actually reset fully if the alphaCap is set to a value lower than 1.
  - translate
```
 abstract Unit translate(Float x, Float y)
```
    translate the origin of all future draw calls by the given amount.
    you must do all your transforms inside a push, pop pair!
  - scale
```
 abstract Unit scale(Float x, Float y)
```
    scales all future draw calls by the given amount.
    you must do all your transforms inside a push, pop pair!
  - rotate
```
 abstract Unit rotate(Double angleRadians)
```
    rotate all future draw calls by the given amount.
    you must do all your transforms inside a push, pop pair!
  - skewX
```
 abstract Unit skewX(Double angleRadians)
```
    Skew all future draw calls by the given amount.
    you must do all your transforms inside a push, pop pair!
    
    Since:
    
    0.16.1
  - skewY
```
 abstract Unit skewY(Double angleRadians)
```
    Skew all future draw calls by the given amount.
    you must do all your transforms inside a push, pop pair!
    
    Since:
    
    0.16.1
  - pushScissor
```
 abstract Unit pushScissor(Float x, Float y, Float width, Float height)
```
    begin a scissor rectangle, that will clip rendering to the given rectangle.
    The scissor is affected by translate, scale, and rotate, and is intersected with the previous scissor.
    you must call popScissor after you are done with this scissor!
  - pushScissorIntersecting
```
 abstract Unit pushScissorIntersecting(Float x, Float y, Float width, Float height)
```
    begin a scissor rectangle, that will clip rendering to the given rectangle. The rectangle is intersected with the previous scissor.
    The scissor is affected by translate, scale, and rotate, and is intersected with the previous scissor.
    you must call popScissor after you are done with this scissor!
  - popScissor
```
 abstract Unit popScissor()
```
    end a scissor.
  - push
```
 abstract Unit push()
```
    Push the current state, saving all the current transforms before creating a new one with the same parameters as the current one.
    This is also called saveState or pushMatrix in many frameworks.
    pop - you must call this after you are finished!
    
    Since:
    
    0.17.2
  - pop
```
 abstract Unit pop()
```
    pop the current state, reverting all transforms to the previous values.
    This is also called restoreState or popMatrix in many frameworks.
    push - you must call this before you are begin!
    
    Since:
    
    0.17.2
  - text
```
 abstract Unit text(Font font, Float x, Float y, String text, Color color, Float fontSize)
```
    draw text to the screen, per the given parameters. The string will already be wrapped to the given width.
  - textBounds
```
 abstract Vec2<Unit.Pixel> textBounds(Font font, String text, Float fontSize)
```
    calculate the bounds of this text, per the given parameters.
    
    Returns:
    
    a Vec2 containing the width and height of the given string. If your API does not support returning string heights, just return the font size. The discrepancy should be negligible.
  - initImage
```
 abstract Unit initImage(PolyImage image)
```
    Function that can be called to explicitly initialize an image. This is used mainly for getting the size of an image, or to ensure an SVG has been rasterized.
  - image
```
 abstract Unit image(PolyImage image, Float x, Float y, Float width, Float height, Integer colorMask, Float topLeftRadius, Float topRightRadius, Float bottomLeftRadius, Float bottomRightRadius)
```
    Draw an image to the screen, per the given parameters.
  - image
```
 final Unit image(PolyImage image, Float x, Float y, Float width, Float height, Float radius, Integer colorMask)
```
  - image
```
 final Unit image(PolyImage image, Float x, Float y, Float width, Float height, FloatArray radii, Integer colorMask)
```
  - rect
```
 abstract Unit rect(Float x, Float y, Float width, Float height, Color color, Float topLeftRadius, Float topRightRadius, Float bottomLeftRadius, Float bottomRightRadius)
```
    draw a rectangle to the screen, per the given parameters.
    If the radii are 0, this will just draw a normal rectangle. If they are not 0, it will draw a rounded rectangle.
  - rect
```
 final Unit rect(Float x, Float y, Float width, Float height, Color color, Float radius)
```
  - rect
```
 final Unit rect(Float x, Float y, Float width, Float height, Color color, FloatArray radii)
```
  - hollowRect
```
 abstract Unit hollowRect(Float x, Float y, Float width, Float height, Color color, Float lineWidth, Float topLeftRadius, Float topRightRadius, Float bottomLeftRadius, Float bottomRightRadius)
```
    draw a hollow rectangle to the screen, per the given parameters.
  - hollowRect
```
 final Unit hollowRect(Float x, Float y, Float width, Float height, Color color, Float lineWidth, Float radius)
```
  - hollowRect
```
 final Unit hollowRect(Float x, Float y, Float width, Float height, Color color, Float lineWidth, FloatArray radii)
```
  - circle
```
 Unit circle(Float x, Float y, Float radius, Color color)
```
    Draw a circle to the screen, as per the given parameters. Note that the x,y is the top left of the circle box, and this is intentional; so it is in-line with the rest of the PolyUI rendering methods.
  - line
```
 abstract Unit line(Float x1, Float y1, Float x2, Float y2, Color color, Float width)
```
    Draws a line between two points with the specified color and width.
    
    Parameters:
    
    x1 - The x-coordinate of the starting point.
    
    y1 - The y-coordinate of the starting point.
    
    x2 - The x-coordinate of the ending point.
    
    y2 - The y-coordinate of the ending point.
    
    color - The color of the line.
    
    width - The width of the line.
  - dropShadow
```
 abstract Unit dropShadow(Float x, Float y, Float width, Float height, Float blur, Float spread, Float radius)
```
    Draw a drop shadow to the screen, per the given parameters.
  - createFramebuffer
```
 abstract Framebuffer createFramebuffer(Float width, Float height)
```
    Create a new framebuffer. It is down to you (as a rendering implementation) to cache this, and dispose of it as necessary.
    
    Returns:
    
    a PolyUI framebuffer object using the width and height passed to this method. This is used by PolyUI to identify it.
  - bindFramebuffer
```
 abstract Unit bindFramebuffer(Framebuffer fbo)
```
    Bind the given framebuffer. Ignore if null.
  - unbindFramebuffer
```
 abstract Unit unbindFramebuffer(Framebuffer fbo)
```
    Unbind the given framebuffer. if it is null, unbind everything.
  - drawFramebuffer
```
 abstract Unit drawFramebuffer(Framebuffer fbo, Float x, Float y, Float width, Float height)
```
    draw the given framebuffer to the screen.
  - delete
```
 abstract Unit delete(Framebuffer fbo)
```
    Delete the given framebuffer. Ignore if null.
  - delete
```
 abstract Unit delete(Font font)
```
    Delete the given font. Use this to free any native resources.
    
    Since:
    
    0.20.1
  - delete
```
 abstract Unit delete(PolyImage image)
```
    Delete the given image. Use this to free any native resources.
    
    Since:
    
    0.20.1
  - cleanup
```
 abstract Unit cleanup()
```
    Cleanup the PolyUI instance. Use this to free any native resources.
  - close
```
 Unit close()
```

Class Renderer

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Renderer

Method Detail

getAlphaCap

setAlphaCap

getPolyUI

getSettings

getPixelRatio

getWidth

setWidth

getHeight

setHeight

render

init

beginFrame

endFrame

globalAlpha

resetAlphaCap

resetGlobalAlpha

translate

scale

rotate

skewX

skewY

pushScissor

pushScissorIntersecting

popScissor

push

pop

text

textBounds

initImage

image

image

image

rect

rect

rect

hollowRect

hollowRect

hollowRect

circle

line

dropShadow

createFramebuffer

bindFramebuffer

unbindFramebuffer

drawFramebuffer

delete

delete

delete

cleanup

close