https://github.com/britzl/lumiere

A collection of post processing effects for Defold
https://github.com/britzl/lumiere

defold defold-library postprocessing

Last synced: 3 months ago
JSON representation

A collection of post processing effects for Defold

• Host: GitHub
• URL: https://github.com/britzl/lumiere
• Owner: britzl
• Created: 2018-11-05T12:55:36.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-05-04T07:00:45.000Z (over 1 year ago)
• Last Synced: 2024-10-25T09:48:39.412Z (3 months ago)
• Topics: defold, defold-library, postprocessing
• Language: Lua
• Homepage:
• Size: 1.4 MB
• Stars: 32
• Watchers: 3
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-defold - Lumiere

README

        
# Lumiere - Work In Progress!

Lumiere is a collection of post processing effects for use in Defold.

## Installation

You can use Lumiere in your own project by adding this project as a [Defold library dependency](http://www.defold.com/manuals/libraries/). Open your game.project file and in the dependencies field under project add:

https://github.com/britzl/lumiere/archive/master.zip

Or point to the ZIP file of a [specific release](https://github.com/britzl/lumiere/releases).

# Usage

Lumiere has to be integrated with your render script to be able to apply effects. 

## Render script integration

Integrating Lumiere is done in two steps:

1. Add `/lumiere/lumiere.go` to a loaded collection, either the bootstrap collection or a loaded proxy collection. This game object contains a full screen quad to which the final composition of post processing effects is drawn.

2. Integrate Lumiere in the render script:

```

-- require lumiere for use in the render script

local lumiere = require("lumiere.lumiere")

function init(self)

	-- initialize lumiere

	lumiere.init()

	-- the rest of your init code

	...

end

function update(self)

	-- update lumiere each frame

	lumiere.update()

	-- your render script update code

	...

	-- wrap any render.draw() calls that should be affected by lumiere effects

	lumiere.draw(function()

		local frustum = self.projection * self.view

		render.draw(self.tile_pred, { frustum = frustum })

		render.draw(self.particle_pred, { frustum = frustum })

	end)

	...

end

function M.on_message(self, message_id, message, sender)

	-- pass messages to lumiere (to detect change in clear color etc)

	lumiere.on_message(message_id, message, sender)

	-- the rest of your on_message code

	...

end

```

## Using effects

Lumiere provides a system to apply multiple post-effects to a game. Examples of effects provided:

* [Blur](lumiere/effects/blur/)

* [Grain](lumiere/effects/grain/)

* [Lights](lumiere/effects/lights/)

* [Chromatic Aberration](lumiere/effects/chromatic_aberration/)

* [LCD](lumiere/effects/lcd/)

* [Scanlines](lumiere/effects/scanlines/)

* [Colorgrade](lumiere/effects/colorgrade/)

Each effect consists of some shader code, a Lua module and a game object. To use an effect the game object for the effect has to be added to a loaded collection, either the bootstrap collection or a loaded proxy collection. The Lua module for the effect also has to be added to Lumiere:

```

local lumiere = require("lumiere.lumiere")

local blur = require("lumiere.effects.blur.blur")

local grain = require("lumiere.effects.grain.grain")

function init(self)

	-- use the blur and grain effect (in that order)

	lumiere.use_effects({ blur, grain })

end

```