Files
jak-project/third-party/SDL/examples/README.md
T
Tyler Wilding 1f6438e517 deps: update to SDL3 (#3852)
This PR updates to SDL3, and with it, adds a handful of new features.
Everything seems to work but I'm going to look over the code once last
time before merging, some of the API changes are hard to spot.

Fixes #2773

### Pressure sensitivity support for DS3 Controllers

SDL3 adds pressure sensitivity support for DS3 controllers on windows. I
have not tested on linux. The option is disabled by default.

On windows you will need https://docs.nefarius.at/projects/DsHidMini/
and to be using SXS mode.

### DualSense and Xbox One Trigger Effects

If enabled, Jak 2 will have certain trigger effects.  They are:
   - xbox1:
     - small vibrate when collecting dark eco
     - big vibrate when changing to dark jak
     - vibrate when shooting gun, proportional to gun type
   - ps5:
     - resistance when changing to dark jak
     - different gun shooting effects
       - red (resistance)
       - yellow (weapon trigger)
       - blue (vibrates)
       - purple (less resistance)
> **Gun Shooting effects are only enabled if the new "Swap R1 and R2"
option is enabled**

There are more effects that could be used in `dualsense_effects.cpp`,
but I only exposed the ones I needed to OpenGOAL. If a modder wants to
use some of the others and wires them up end-to-end, please consider
contributing that upstream.

### New ImGUI Menu

Added new imgui options for selecting the active controller, for those
people that struggle to select the initial controller.


![image](https://github.com/user-attachments/assets/48ff2985-d9ef-417a-b1f2-a25c74595935)

### Testing

The highlights of what I tested successfully:
   - display
     - [x] all mode switch permutations
     - [x] launch with all modes saved
- [x] switch monitors / unplug monitor that was active, how does it
handle it
     - [x] load with alternate monitor saved and all modes
     - [x] allowing hidpi doesnt break macos
   - controls
     - [x] keyboard and mouse still work
     - [x] pressure sensitivity on linux
2025-03-02 16:36:22 -05:00

2.5 KiB
Vendored
Generated

Examples

What is this?

In here are a collection of standalone SDL application examples. Unless otherwise stated, they should work on all supported platforms out of the box. If they don't please file a bug to let us know.

What is this SDL_AppIterate thing?

SDL can optionally build apps as a collection of callbacks instead of the usual program structure that starts and ends in a function called main. The examples use this format for two reasons.

First, it allows the examples to work when built as web applications without a pile of ugly #ifdefs, and all of these examples are published on the web at examples.libsdl.org, so you can easily see them in action.

Second, it's example code! The callbacks let us cleanly break the program up into the four logical pieces most apps care about:

  • Program startup
  • Event handling
  • What the program actually does in a single frame
  • Program shutdown

A detailed technical explanation of these callbacks is in docs/README-main-functions.md (or view that page on the web on the wiki).

I would like to build and run these examples myself.

When you build SDL with CMake, you can add -DSDL_EXAMPLES=On to the CMake command line. When you build SDL, these examples will be built with it.

But most of these can just be built as a single .c file, as long as you point your compiler at SDL3's headers and link against SDL.

What is the license on the example code? Can I paste this into my project?

All code in the examples directory is considered public domain! You can do anything you like with it, including copy/paste it into your closed-source project, sell it, and pretend you wrote it yourself. We do not require you to give us credit for this code (but we always appreciate if you do!).

This is only true for the examples directory. The rest of SDL falls under the zlib license.

What is template.html and highlight-plugin.lua in this directory?

This is what examples.libsdl.org uses when generating the web versions of these example programs. You can ignore this, unless you are improving it, in which case we definitely would love to hear from you!

What is template.c in this directory?

If writing new examples, this is the skeleton code we start from, to keep everything consistent. You can ignore it.