Skip to content

Commit

Permalink
Updated Readme and version number
Browse files Browse the repository at this point in the history
  • Loading branch information
HexagonNico committed Mar 28, 2023
1 parent 86f9b72 commit 97236cc
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,16 @@ position = translation.multiply(position);

## Color math

VecMatLib also provides a structure to represent a color as four floating point values between 0.0 and 1.0 because colors are essentially 4D vectors.
VecMatLib also provides a structure to represent a color as four-dimensional or three-dimensional floating point tuples with values between 0.0 and 1.0.

```scala
val white = Color(1.0f, 1.0f, 1.0f) // (red = 1.0, green = 1.0, blue = 1.0, alpha = 1.0)
val green = Color(0.0f, 1.0f, 0.0f) // (red = 0.0, green = 1.0, blue = 0.0, alpha = 1.0)
val transparentBlue = Color(0.0f, 0.0f, 1.0f, 0.5f) // (red = 0.0, green = 0.0, blue = 1.0, alpha = 0.5)
```

Values outside the range (0.0, 1.0) are allowed.

## Using with LWJGL

VecMatLib can be used together with [LWJGL](https://lwjgl.org) to set uniform variables in shaders.
Expand Down Expand Up @@ -120,7 +122,7 @@ allprojects {

```groovy
dependencies {
implementation 'com.github.HexagonNico:VecMatLib:1.1'
implementation 'com.github.HexagonNico:VecMatLib:1.2'
}
```

Expand All @@ -139,7 +141,7 @@ dependencies {
<dependency>
<groupId>com.github.HexagonNico</groupId>
<artifactId>VecMatLib</artifactId>
<version>1.1</version>
<version>1.2</version>
</dependency>
```

Expand All @@ -150,7 +152,7 @@ resolvers += "jitpack" at "https://jitpack.io"
```

```sbt
libraryDependencies += "com.github.HexagonNico" % "VecMatLib" % "1.1"
libraryDependencies += "com.github.HexagonNico" % "VecMatLib" % "1.2"
```

## Support the project
Expand All @@ -163,4 +165,4 @@ Initially a university project, later completed and turned into a fully usable l

## Contributing

Your contributions are always welcome! Please submit a pull request or open an issue if you want to contribute with bug fixes, code improvements and better unit test coverage.
Your contributions are always welcome! Please submit a pull request or open an issue if you want to contribute with bug fixes, code improvements, documentation, and better unit test coverage.
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ThisBuild / version := "1.1"
ThisBuild / version := "1.2"

ThisBuild / scalaVersion := "2.13.10"

Expand Down

0 comments on commit 97236cc

Please sign in to comment.