MiniFB 0.7.0-alpha1

MiniFB

TODO: ...

Requirements

• .NET8 or above

• currently Windows and Linux only, but you've got all relevant architectures there (x64, x86, arm64, arm)

  There's a plan to further expand the supported platforms in the future.

• for additional usage dependencies per platform see USAGE.md

• for building requirements see BUILD.md

Usage

See the quickstart guide.

Alternatively, you can see USAGE.md for a more in depth look on how to use MiniFB, or have a look at the sample applications.

Building

See BUILD.md.

Quickstart

Add a reference to your .NET8+ C#-project

In your .csproj file, add reference to the MiniFB package from NuGet:

<ItemGroup>
    <PackageReference Include="MiniFB" Version="0.7.0">
</ItemGroup>

Add a using directive to import from the MiniFB namespace

Add a using directive to the top a code file, where you want to reference parts of MiniFB:

using MiniFB;

Prepare your frame buffer

The frame buffer holds the data for each individual pixel for each frame:

var buffer = new Argb[800 * 600];

Create a window

You can create a new Window by simply calling it's constructor:

using var window = new Window("Hello World!", 800, 600);

Establish a main loop and redraw your frame buffer in each frame

In each frame, you'll most likely want to redraw the contents of your frame buffer:

do
{
    // your frame redraw logic goes here
}
while (...);

Update your window at the end of each frame

At the end of each frame, you want to update the window with the contents of your redrawn frame buffer and after that wait for frame synchronization.

Inside the tailing while statement from above, insert the following, so it looks like that:

while (
    // update the window with the contents of the frame buffer ...
    window.Update(buffer) is UpdateState.Ok

    // ... and then wait for frame synchronization
    && window.WaitForSync();
);