fix: Fix server session (#2913)

* fix server session

* fix version
This commit is contained in:
Ilkka Seppälä
2024-04-11 22:11:42 +03:00
committed by GitHub
parent 44071ab497
commit 56dfd8c2d7
11 changed files with 445 additions and 371 deletions
+178 -154
View File
@@ -1,38 +1,31 @@
---
title: Double Buffer
title: Double Buffer
category: Behavioral
language: en
tag:
- Performance
- Game programming
tag:
- Buffering
- Game programming
- Optimization
- Performance
---
## Intent
Double buffering is a term used to describe a device that has two buffers. The usage of multiple
buffers increases the overall throughput of a device and helps prevents bottlenecks. This example
shows using double buffer pattern on graphics. It is used to show one image or frame while a separate
frame is being buffered to be shown next. This method makes animations and games look more realistic
than the same done in a single buffer mode.
## Intent
The Double Buffer pattern aims to reduce the time necessary for rendering and displaying graphical or computational data by utilizing two buffers. One buffer is used for rendering the next frame or computing the next set of data, while the other is used to display the current frame or data set to the user.
## Explanation
Real world example
> A typical example, and one that every game engine must address, is rendering. When the game draws
> the world the users see, it does so one piece at a time -- the mountains in the distance,
> the rolling hills, the trees, each in its turn. If the user watched the view draw incrementally
> like that, the illusion of a coherent world would be shattered. The scene must update smoothly
> and quickly, displaying a series of complete frames, each appearing instantly. Double buffering solves
> the problem.
> A typical example, and one that every game engine must address, is rendering. When the game draws the world the users see, it does so one piece at a time -- the mountains in the distance, the rolling hills, the trees, each in its turn. If the user watched the view draw incrementally like that, the illusion of a coherent world would be shattered. The scene must update smoothly and quickly, displaying a series of complete frames, each appearing instantly. Double buffering solves the problem.
In plain words
> It ensures a state that is being rendered correctly while that state is modifying incrementally. It is
> widely used in computer graphics.
> It ensures a state that is being rendered correctly while that state is modifying incrementally. It is widely used in computer graphics.
Wikipedia says
> In computer science, multiple buffering is the use of more than one buffer to hold a block of data,
> so that a "reader" will see a complete (though perhaps old) version of the data, rather than a
> partially updated version of the data being created by a "writer". It is very commonly used for
> computer display images.
> In computer science, multiple buffering is the use of more than one buffer to hold a block of data, so that a "reader" will see a complete (though perhaps old) version of the data, rather than a partially updated version of the data being created by a "writer". It is very commonly used for computer display images.
**Programmatic Example**
@@ -44,76 +37,77 @@ Buffer interface that assures basic functionalities of a buffer.
*/
public interface Buffer {
/**
* Clear the pixel in (x, y).
*
* @param x X coordinate
* @param y Y coordinate
*/
void clear(int x, int y);
/**
* Clear the pixel in (x, y).
*
* @param x X coordinate
* @param y Y coordinate
*/
void clear(int x, int y);
/**
* Draw the pixel in (x, y).
*
* @param x X coordinate
* @param y Y coordinate
*/
void draw(int x, int y);
/**
* Draw the pixel in (x, y).
*
* @param x X coordinate
* @param y Y coordinate
*/
void draw(int x, int y);
/**
* Clear all the pixels.
*/
void clearAll();
/**
* Clear all the pixels.
*/
void clearAll();
/**
* Get all the pixels.
*
* @return pixel list
*/
Pixel[] getPixels();
/**
* Get all the pixels.
*
* @return pixel list
*/
Pixel[] getPixels();
}
```
One of the implementation of Buffer interface.
```java
/**
* FrameBuffer implementation class.
*/
public class FrameBuffer implements Buffer {
public static final int WIDTH = 10;
public static final int HEIGHT = 8;
public static final int WIDTH = 10;
public static final int HEIGHT = 8;
private final Pixel[] pixels = new Pixel[WIDTH * HEIGHT];
private final Pixel[] pixels = new Pixel[WIDTH * HEIGHT];
public FrameBuffer() {
clearAll();
}
public FrameBuffer() {
clearAll();
}
@Override
public void clear(int x, int y) {
pixels[getIndex(x, y)] = Pixel.WHITE;
}
@Override
public void clear(int x, int y) {
pixels[getIndex(x, y)] = Pixel.WHITE;
}
@Override
public void draw(int x, int y) {
pixels[getIndex(x, y)] = Pixel.BLACK;
}
@Override
public void draw(int x, int y) {
pixels[getIndex(x, y)] = Pixel.BLACK;
}
@Override
public void clearAll() {
Arrays.fill(pixels, Pixel.WHITE);
}
@Override
public void clearAll() {
Arrays.fill(pixels, Pixel.WHITE);
}
@Override
public Pixel[] getPixels() {
return pixels;
}
@Override
public Pixel[] getPixels() {
return pixels;
}
private int getIndex(int x, int y) {
return x + WIDTH * y;
}
private int getIndex(int x, int y) {
return x + WIDTH * y;
}
}
```
@@ -123,11 +117,13 @@ public class FrameBuffer implements Buffer {
*/
public enum Pixel {
WHITE,
BLACK;
WHITE,
BLACK;
}
```
Scene represents the game scene where current buffer has already been rendered.
```java
/**
* Scene class. Render the output frame.
@@ -135,93 +131,94 @@ Scene represents the game scene where current buffer has already been rendered.
@Slf4j
public class Scene {
private final Buffer[] frameBuffers;
private final Buffer[] frameBuffers;
private int current;
private int current;
private int next;
private int next;
/**
* Constructor of Scene.
*/
public Scene() {
frameBuffers = new FrameBuffer[2];
frameBuffers[0] = new FrameBuffer();
frameBuffers[1] = new FrameBuffer();
current = 0;
next = 1;
}
/**
* Constructor of Scene.
*/
public Scene() {
frameBuffers = new FrameBuffer[2];
frameBuffers[0] = new FrameBuffer();
frameBuffers[1] = new FrameBuffer();
current = 0;
next = 1;
}
/**
* Draw the next frame.
*
* @param coordinateList list of pixels of which the color should be black
*/
public void draw(List<? extends Pair<Integer, Integer>> coordinateList) {
LOGGER.info("Start drawing next frame");
LOGGER.info("Current buffer: " + current + " Next buffer: " + next);
frameBuffers[next].clearAll();
coordinateList.forEach(coordinate -> {
var x = coordinate.getKey();
var y = coordinate.getValue();
frameBuffers[next].draw(x, y);
});
LOGGER.info("Swap current and next buffer");
swap();
LOGGER.info("Finish swapping");
LOGGER.info("Current buffer: " + current + " Next buffer: " + next);
}
/**
* Draw the next frame.
*
* @param coordinateList list of pixels of which the color should be black
*/
public void draw(List<? extends Pair<Integer, Integer>> coordinateList) {
LOGGER.info("Start drawing next frame");
LOGGER.info("Current buffer: " + current + " Next buffer: " + next);
frameBuffers[next].clearAll();
coordinateList.forEach(coordinate -> {
var x = coordinate.getKey();
var y = coordinate.getValue();
frameBuffers[next].draw(x, y);
});
LOGGER.info("Swap current and next buffer");
swap();
LOGGER.info("Finish swapping");
LOGGER.info("Current buffer: " + current + " Next buffer: " + next);
}
public Buffer getBuffer() {
LOGGER.info("Get current buffer: " + current);
return frameBuffers[current];
}
public Buffer getBuffer() {
LOGGER.info("Get current buffer: " + current);
return frameBuffers[current];
}
private void swap() {
current = current ^ next;
next = current ^ next;
current = current ^ next;
}
private void swap() {
current = current ^ next;
next = current ^ next;
current = current ^ next;
}
}
```
```java
public static void main(String[] args) {
final var scene = new Scene();
var drawPixels1 = List.of(
new MutablePair<>(1, 1),
new MutablePair<>(5, 6),
new MutablePair<>(3, 2)
);
scene.draw(drawPixels1);
var buffer1 = scene.getBuffer();
printBlackPixelCoordinate(buffer1);
public static void main(String[]args){
final var scene=new Scene();
var drawPixels1=List.of(
new MutablePair<>(1,1),
new MutablePair<>(5,6),
new MutablePair<>(3,2)
);
scene.draw(drawPixels1);
var buffer1=scene.getBuffer();
printBlackPixelCoordinate(buffer1);
var drawPixels2 = List.of(
new MutablePair<>(3, 7),
new MutablePair<>(6, 1)
);
scene.draw(drawPixels2);
var buffer2 = scene.getBuffer();
printBlackPixelCoordinate(buffer2);
}
var drawPixels2=List.of(
new MutablePair<>(3,7),
new MutablePair<>(6,1)
);
scene.draw(drawPixels2);
var buffer2=scene.getBuffer();
printBlackPixelCoordinate(buffer2);
}
private static void printBlackPixelCoordinate(Buffer buffer) {
StringBuilder log = new StringBuilder("Black Pixels: ");
var pixels = buffer.getPixels();
for (var i = 0; i < pixels.length; ++i) {
if (pixels[i] == Pixel.BLACK) {
var y = i / FrameBuffer.WIDTH;
var x = i % FrameBuffer.WIDTH;
private static void printBlackPixelCoordinate(Buffer buffer){
StringBuilder log=new StringBuilder("Black Pixels: ");
var pixels=buffer.getPixels();
for(var i=0;i<pixels.length;++i){
if(pixels[i]==Pixel.BLACK){
var y=i/FrameBuffer.WIDTH;
var x=i%FrameBuffer.WIDTH;
log.append(" (").append(x).append(", ").append(y).append(")");
}
}
LOGGER.info(log.toString());
}
}
}
LOGGER.info(log.toString());
}
```
The console output
```text
[main] INFO com.iluwatar.doublebuffer.Scene - Start drawing next frame
[main] INFO com.iluwatar.doublebuffer.Scene - Current buffer: 0 Next buffer: 1
@@ -240,16 +237,43 @@ The console output
```
## Class diagram
![alt text](./etc/double-buffer.urm.png "Double Buffer pattern class diagram")
## Applicability
This pattern is one of those ones where youll know when you need it. If you have a system that lacks double buffering, it will probably look visibly wrong (tearing, etc.) or will behave incorrectly. But saying, “youll know when you need it” doesnt give you much to go on. More specifically, this pattern is appropriate when all of these are true:
![Double Buffer class diagram](./etc/double-buffer.urm.png "Double Buffer pattern class diagram")
- We have some state that is being modified incrementally.
- That same state may be accessed in the middle of modification.
- We want to prevent the code thats accessing the state from seeing the work in progress.
- We want to be able to read the state and we dont want to have to wait while its being written.
## Applicability
## Credits
* [Game Programming Patterns - Double Buffer](http://gameprogrammingpatterns.com/double-buffer.html)
* Real-time applications where the display needs to be updated frequently and smoothly, such as video games, simulations, and graphical user interfaces.
* Applications requiring high computational resources to prepare data, where the preparation can be done in parallel with data consumption.
* Scenarios where the goal is to minimize the perception of lag or stutter in the display of data or graphics.
## Known Uses
* Graphics Rendering Engines: Used extensively in 2D and 3D rendering engines to ensure smooth animations and transitions.
* User Interface Frameworks: Employed in GUI frameworks to enhance the responsiveness and smoothness of interfaces.
* Simulation and Modeling: Utilized in simulations to display real-time updates without interrupting the simulation process.
* Video Playback Software: Applied in video players to provide seamless playback by preloading the next frame while the current one is displayed.
## Consequences
Benefits:
* Smooth User Experience: Provides a seamless display experience by pre-rendering frames, leading to smoother animations and transitions.
* Performance Optimization: Allows intensive rendering or data preparation tasks to be performed in the background, optimizing overall performance.
* Minimizes Flickering: Reduces or eliminates flickering and visual artifacts in graphical applications.
Trade-offs:
* Memory Overhead: Requires additional memory for the secondary buffer, potentially doubling the memory usage for the buffered data.
* Implementation Complexity: Adds complexity to the system architecture, requiring careful management of the two buffers.
* Latency: Can introduce a slight delay, as the data must be fully rendered or prepared in the back buffer before being displayed.
## Related Patterns
* Triple Buffering: An extension of the Double Buffer pattern, where three buffers are used to further optimize rendering and reduce latency.
* [Producer-Consumer](https://java-design-patterns.com/patterns/producer-consumer/): The Double Buffer pattern can be seen as a variant of the Producer-Consumer pattern, with one buffer being "produced" while the other is "consumed".
* [Strategy](https://java-design-patterns.com/patterns/strategy/): Often used in conjunction with the Strategy pattern to dynamically choose the buffering strategy based on runtime conditions.
## Credits
* [Game Programming Patterns - Double Buffer](https://amzn.to/4ayDNkS)
* [Real-Time Design Patterns: Robust Scalable Architecture for Real-Time Systems](https://amzn.to/3xFfNxA)
@@ -30,5 +30,5 @@ package com.iluwatar.doublebuffer;
public enum Pixel {
WHITE,
BLACK;
BLACK
}