Module io.github.sosuisen.api.jfxbuilder.graphics

Package io.github.sosuisen.jfxbuilder.graphics

Class PixelBufferBuilder<T extends Buffer>

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.PixelBufferBuilder<T>

public class PixelBufferBuilder<T extends Buffer>
extends Object

The PixelBufferBuilder class constructs instances of the PixelBuffer class and offers a fluent interface for creating and configuring it.

This class includes a static create method that accepts the same arguments as the original PixelBuffer constructor and returns an instance of the PixelBufferBuilder.

You can use method chaining to call the builder methods for configuring the PixelBuffer. Finally, invoke the build method to generate an instance of the PixelBuffer class.

Note that intermediate builder methods are not evaluated until the build method is called, meaning they are evaluated lazily.

Author:

Hidekazu Kubota <hidekazu.kubota@gmail.com>

Method Summary

Modifier and Type	Method	Description
PixelBufferBuilder<T>	apply(Consumer<PixelBuffer<T>> func)	Applies a function to the PixelBuffer instance being constructed.
PixelBuffer<T>	build()	Builds and returns an instance of the PixelBuffer class.
static <T extends Buffer> PixelBufferBuilder<T>	create(int width, int height, T buffer, PixelFormat<T> pixelFormat)	Accepts the constructor arguments of PixelBuffer(int, int, T, PixelFormat) and returns an instance of PixelBufferBuilder<T>.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static <T extends Buffer>
PixelBufferBuilder<T> create(int width,
 int height,
 T buffer,
 PixelFormat<T> pixelFormat)

Accepts the constructor arguments of PixelBuffer(int, int, T, PixelFormat) and returns an instance of PixelBufferBuilder<T>.

Returns:

an instance of the PixelBufferBuilder<T>.

build

public PixelBuffer<T> build()

Builds and returns an instance of the PixelBuffer class.

Intermediate builder methods are not evaluated until the build method is called; in other words, they are evaluated lazily.

Returns:

new instance of the PixelBuffer class

apply

public PixelBufferBuilder<T> apply(Consumer<PixelBuffer<T>> func)

Applies a function to the PixelBuffer instance being constructed. Most operations on the instance can be performed using this method.

Returns:

builder instance