@quenty/color3utils 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/color3utils@2.0.0...@quenty/color3utils@2.0.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/color3utils
+
+
+
+
+
 # [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/color3utils@1.2.0...@quenty/color3utils@2.0.0) (2021-09-05)
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,10 +1,10 @@
 ## Color3Utils
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,27 +13,9 @@
 
 Utility methods for Roblox Color3 values
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/Color3Utils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/color3utils --save
-```
-
-## Usage
-Usage is designed to be simple.
-
-### `Color3Utils.getRelativeLuminance(color)`
-Luminance as per W3 per sRGB colorspace normalized with 0
-
-### `Color3Utils.textShouldBeBlack(color)`
-Returns whether or not the text should be black using
-
-### `Color3Utils.scaleValue(color3, percent)`
-
-### `Color3Utils.setValue(color3, value)`
-
-### `Color3Utils.setHue(color3, hue)`
-
-### `Color3Utils.scaleSaturation(color3, percent)`
-
-### `Color3Utils.setSaturation(color3, saturation)`
-
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/color3utils",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Utility methods for Roblox Color3 values",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c06170ec47b0d4520c587ce2e6404d14b5dbb851"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/Color3Utils.lua

@@ -1,13 +1,20 @@
---- Utility methods for Roblox Color3 values
--- @module Color3Utils
+--[=[
+	Utility methods for Roblox Color3 values
+	@class Color3Utils
+]=]
 
 local Color3Utils = {}
 
---- Luminance as per W3 per sRGB colorspace normalized with 0
--- as the darkest dark, and 1 as the whitest white
--- @tparam {Color3} color The Color3 to check
--- @treturn A scalar from 0 to 1 with 0 as the darkest dark, and 1 as the whitest white
--- See https://www.w3.org/TR/WCAG20/#relativeluminancedef
+--[=[
+	 Luminance as per W3 per sRGB colorspace normalized with 0
+	 as the darkest dark, and 1 as the whitest white.
+
+	 See https://www.w3.org/TR/WCAG20/#relativeluminancedef
+
+	 @param color Color3 -- The Color3 to check
+	 @return number -- A scalar from 0 to 1 with 0 as the darkest dark, and 1 as the whitest white
+
+]=]
 function Color3Utils.getRelativeLuminance(color)
 	local components = { color.r, color.g, color.b }
 	local vals = {}
@@ -22,35 +29,69 @@ function Color3Utils.getRelativeLuminance(color)
 	return 0.2126 * vals[1] + 0.7152 * vals[2] + 0.0722 * vals[3]
 end
 
---- Returns whether or not the text should be black using
--- relative luminance as a metric.
--- @tparam {Color3} color The Color3 to check
--- @treturn {boolean} True if the text should be black, false if it should be good
--- See https://stackoverflow.com/questions/3942878/
+--[=[
+	Returns whether or not the text should be black using
+	relative luminance as a metric.
+
+	See https://stackoverflow.com/questions/3942878/
+
+	@param color Color3 -- The Color3 to check
+	@return boolean -- True if the text should be black, false if it should be good
+]=]
 function Color3Utils.textShouldBeBlack(color)
 	return Color3Utils.getRelativeLuminance(color) > 0.179
 end
 
+--[=[
+	Scales the value component of hsv
+	@param color3 Color3
+	@param percent number -- Percent scaling
+	@return Color3
+]=]
 function Color3Utils.scaleValue(color3, percent)
 	local h, s, v = Color3.toHSV(color3)
 	return Color3.fromHSV(h, s, percent*v)
 end
 
+--[=[
+	Sets the value component of hsv
+	@param color3 Color3
+	@param value number
+	@return Color3
+]=]
 function Color3Utils.setValue(color3, value)
 	local h, s, _ = Color3.toHSV(color3)
 	return Color3.fromHSV(h, s, value)
 end
 
+--[=[
+	Sets the hue component of hsv
+	@param color3 Color3
+	@param hue number
+	@return Color3
+]=]
 function Color3Utils.setHue(color3, hue)
 	local _, s, v = Color3.toHSV(color3)
 	return Color3.fromHSV(hue, s, v)
 end
 
+--[=[
+	Scales the saturation component of hsv
+	@param color3 Color3
+	@param percent number -- Percent scaling
+	@return Color3
+]=]
 function Color3Utils.scaleSaturation(color3, percent)
 	local h, s, v = Color3.toHSV(color3)
 	return Color3.fromHSV(h, percent*s, v)
 end
 
+--[=[
+	Sets the saturation component of hsv
+	@param color3 Color3
+	@param saturation number
+	@return Color3
+]=]
 function Color3Utils.setSaturation(color3, saturation)
 	local h, _, v = Color3.toHSV(color3)
 	return Color3.fromHSV(h, saturation, v)