glsl_include_transformer 0.1.3

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 44

glsl_include_transformer.dart

Transformer preprocessor for include directives in .glsl shader files.

Build Status

C-style include preprocessor directives are a basic way to reuse code snippets across multitple files. However, although OpenGL/WebGL implementations support most C-style preprocessor directives, include is a notable exception. This package adds support for include preprocessor directives through a Pub transformer that performs an additional preprocessing step at build time.

Usage

Add the glsl_include_transformer to the transformer list in your pubspec.yaml:

transformers:
  - glsl_include_transformer

This transformer will substitute include directives in .glsl files with the contents of the file they reference:

// Gets replaced with the contents of partials/my_shader_partial.glsl
#include "partials/my_shader_partial.glsl"

// Or alternatively, if you prefer angle brackets
#include <partials/my_shader_partial.glsl>

The include directive must reference a URI enclosed in double quotes or angle brackets. Unlike in C or C++ preprocessors there is no semantic difference between double quotes or angle brackets. The URI must be a relative URI (absolute URIs are not allowed):

// my_package/lib/shaders/my_shader.glsl

// Includes my_package|lib/shaders/partials/some_shader_partial.glsl
#include "partials/some_shader_partial.glsl"

A URI may reach into another package via the packages directory:

// my_package/lib/shaders/my_shader.glsl

// Includes some_package|lib/shaders/some_shader_partial.glsl
#include "../../packages/some_package/shaders/some_shader_partial.glsl"

You may only reference files in another package's lib directory. Note that URIs that reference another package should not contain a lib segment.

GLSL Include Transformer Change Log

0.1.0

Initial version.

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  glsl_include_transformer: "^0.1.3"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:glsl_include_transformer/glsl_include_transformer.dart';
        
Version Uploaded Documentation Archive
0.1.3 Oct 22, 2016 Go to the documentation of glsl_include_transformer 0.1.3 Download glsl_include_transformer 0.1.3 archive
0.1.2 Aug 30, 2016 Go to the documentation of glsl_include_transformer 0.1.2 Download glsl_include_transformer 0.1.2 archive
0.1.1 Aug 27, 2016 Go to the documentation of glsl_include_transformer 0.1.1 Download glsl_include_transformer 0.1.1 archive

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • completed on Feb 3, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
0 / 100
Health:
Code health derived from static analysis. [more]
99 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
72 / 100
Overall score:
Weighted score of the above. [more]
44

Platforms

Detected platforms: Flutter, other

Primary library: package:glsl_include_transformer/glsl_include_transformer.dart with components: io, build.

Suggestions

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use glsl_include_transformer.dart.

  • Use analysis_options.yaml.

    Rename old .analysis_options file to analysis_options.yaml.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.0.0 <2.0.0
barback >=0.15.2 <0.16.0 0.15.2+14
code_transformers >=0.4.2 <0.5.0 0.4.2+4 0.5.1+4
source_span >=1.2.3 <2.0.0 1.4.0
Transitive dependencies
analyzer 0.29.11 0.31.0+1
args 0.13.7 1.3.0
async 2.0.3
charcode 1.1.1
cli_util 0.0.1+2 0.1.2+1
collection 1.14.5
convert 2.0.1
crypto 2.0.2+1
csslib 0.14.1
glob 1.1.5
html 0.13.2+2
isolate 1.1.0
logging 0.11.3+1
meta 1.1.2
package_config 1.0.3
path 1.5.1
plugin 0.2.0+2
pool 1.3.4
source_maps 0.10.4
stack_trace 1.9.1
string_scanner 1.0.2
typed_data 1.1.5
utf 0.9.0+4
watcher 0.9.7+7
when 0.2.0
which 0.1.3
yaml 2.1.13
Dev dependencies
test >=0.12.0 <0.13.0
transformer_test >=0.2.1 <0.3.0