PSFML is Pascal binding for the Simple and Fast Multimedia Library (SFML), allowing Pascal developers with an easy way to use SFML’s multimedia features directly in their projects. Whether you are building games, interactive applications, or multimedia tools, PSFML enables seamless integration with SFML, bringing its robust functionality to the Pascal ecosystem.

Table of Contents

• Introduction
• Features
• Getting Started
  • Requirements
  • Installation
• Usage
  • Basic Example
• Extensions
• Contributing
• License

Introduction

PSFML leverages the power of SFML and makes it accessible to Pascal programmers. With PSFML, you can create windowed applications, manage graphics, handle real-time user input, play audio, and even stream video. Built to work on Windows (Windows 10 and higher) and compatible with Delphi.

Why PSFML?

• Pascal-First: PSFML is developed specifically for Pascal developers, providing a natural and intuitive API.
• No DLL Hassles: Simply add PSFML to your uses section, and everything you need is embedded in your executable. There’s no need to manage external DLLs.
• Compiler Support: Supports Delphi (Community Edition and higher), and works on Windows 64-bit (tested on Windows 11, developed in Delphi 12.2).
• Latest SFML: In sync with latest SFML release, so you can use all the latest features of the library.

Features

• Core SFML Integration: Use SFML’s core features directly from Pascal, including window management, real-time rendering, audio playback, and network communication.
• Extensions:
  • ZipFile: Standard compression and encryption support, allowing you to handle archived content seamlessly.
  • Video Playback (MPEG-1): Stream and play videos within your applications.
  • Enhanced InputStream: Works with ZipFile, enabling smooth file handling.
  • HighDPI: Routines that allows you to scale the render window size based on the desktop DPI value and automatically when the DPI value changes.
  • More: Additional extensions will be added in future updates.
• Optimized for Windows: Developed and tested on Windows 11 with Delphi 12.2, PSFML is designed to be stable and performant for game and multimedia applications.

Getting Started

Requirements

• Delphi CE or a higher edition. RAD Studio 12.2 is required to build the sources.
• Windows 10 or higher (64-bit).

Installation

1. Download the latest version of PSFML.
2. Extract the contents to your project directory.
3. Add the PSFML lib folder to your Library Path.
4. In your project, include PSFML in your uses section. To take advantage of extensions, you must also add PSFML.Ext after PSFML in your uses section.
5. Refer to the examples folder for detailed usage instructions and examples on how to utilize PSFML effectively.
6. Make sure to run the ZipFile01 example first to generate the data.zip file required by the other examples.

Usage

Basic Example

Here’s a simple example of how to create a window and handle real-time user input using PSFML:

uses
  System.SysUtils,
  PSFML,     // add core SFML
  PSFML.Ext; // add extensions. Must always come AFTER PSFML
var
  LWindow: PsfRenderWindow;
  LEvent: sfEvent;
  LFont: array[0..0] of PsfFont;
  LText: array[0..0] of PsfText;
  LHudPos: sfVector2f;
begin
  LWindow := sfRenderWindow_create('PSFML: RenderWindow #01');

  LFont[0] := sfFont_CreateDefaultFont();
  sfFont_SetSmooth(LFont[0], True);

  LText[0] := sfText_Create(LFont[0]);
  sfText_SetCharacterSize(LWindow, LText[0], 12);

  sfRenderWindow_clear(LWindow, BLACK);
  sfRenderWindow_clearFrame(LWindow, DARKSLATEBROWN);

  while sfRenderWindow_isOpen(LWindow) do
  begin

    while sfRenderWindow_pollEvent(LWindow, @LEvent) do
    begin
      case LEvent.&type of
        sfEvtClosed:
        begin
          sfRenderWindow_close(LWindow);
        end;

        sfEvtResized:
        begin
          sfRenderWindow_resizeFrame(LWindow, LEvent.size.width, LEvent.size.height);
        end;

        sfEvtKeyReleased:
        begin
          case LEvent.key.code of
            sfKeyEscape:
            begin
              sfRenderWindow_close(LWindow);
            end;
          end;
        end;
      end;
    end;

    sfRenderWindow_startFrame(LWindow);

      sfRenderWindow_drawFilledRect(LWindow, LWindow.Size.x-50, 0, 50, 50, RED);

      LHudPos := sfVector2f_Create(3, 3);
      sfRenderWindow_DrawTextVarY(LWindow, LText[0], LHudPos.x, LHudPos.y, WHITE,
        '%d fps', [sfRenderWindow_GetFrameRate(LWindow)]);
      sfRenderWindow_DrawTextVarY(LWindow, LText[0], LHudPos.x, LHudPos.y, DARKGREEN,
        'ESC - Quit', []);

    sfRenderWindow_endFrame(LWindow);

    sfRenderWindow_display(LWindow);
  end;

  sfText_Destroy(LText[0]);
  sfFont_Destroy(LFont[0]);

  sfRenderWindow_destroy(LWindow);
end.

This code opens a window, listens for a close event, displays a font and updates the display, giving you a starting point for any real-time application.

Extensions

ZipFile Support

PSFML includes built-in support for compressed and encrypted zip files using ZipFile. You can easily extract resources, such as textures or sounds, directly from a zip archive within your game or application.

Video Playback (MPEG-1)

Play MPEG-1 video files within your application using the video playback extension. This feature is particularly useful for cutscenes or background video.

Enhanced InputStream

The Enhanced InputStream works seamlessly with ZipFile, allowing you to access archived files and stream them in real-time.

Contributing

Contributions to PSFML are welcome! If you’d like to contribute to this project, feel free to submit issues or pull requests on our GitHub repository.

License

PSFML is licensed under the BSD-3-Clause License, which permits redistribution and use in source and binary forms, with or without modification, under specific conditions. See the LICENSE file for more details.

Support

• Issues
• Discussions
• SFML website
• SFML on YouTube

Made with ❤️ in Delphi