mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-01-12 20:22:49 +08:00
Code Issues Packages Projects Releases Wiki Activity
097b81f147
godot/modules/opensimplex/doc_classes/OpenSimplexNoise.xml

113 lines
5.1 KiB
XML
Raw Normal View History

Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 21:18:53 +08:00
<class name="OpenSimplexNoise" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
<brief_description>
Noise generator based on Open Simplex.
</brief_description>
<description>
Renaming SimplexNoise refs to OpenSimplexNoise Because I think github doesn't show history of renamed files - The original work is done in commit f12a1b8 by JFonS - Improved Documentation in commit a386af6 - Last change on the files was in commit 463af5b - and Fixed compiler warnings in commit e5bbcb8bcf8180a54fdcc5c4291b153246d861ce
2018-09-28 19:30:07 +08:00
This resource allows you to configure and sample a fractal noise space. Here is a brief usage example that configures an OpenSimplexNoise and gets samples at various positions and dimensions:
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
[codeblock]
Renaming SimplexNoise refs to OpenSimplexNoise Because I think github doesn't show history of renamed files - The original work is done in commit f12a1b8 by JFonS - Improved Documentation in commit a386af6 - Last change on the files was in commit 463af5b - and Fixed compiler warnings in commit e5bbcb8bcf8180a54fdcc5c4291b153246d861ce
2018-09-28 19:30:07 +08:00
var noise = OpenSimplexNoise.new()
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
# Configure
noise.seed = randi()
noise.octaves = 4
noise.period = 20.0
doc: Sync classref with current source
2018-09-21 15:33:05 +08:00
noise.persistence = 0.8
Improve SimplexNoise documentation and fix typos Spaces were added after code blocks to ensure correct rendering on the online class reference.
2018-09-20 02:05:55 +08:00
# Sample
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
print("Values:")
Improve SimplexNoise documentation and fix typos Spaces were added after code blocks to ensure correct rendering on the online class reference.
2018-09-20 02:05:55 +08:00
print(noise.get_noise_2d(1.0, 1.0))
print(noise.get_noise_3d(0.5, 3.0, 15.0))
Fix typo in SimplexNoise documentation
2018-09-20 17:03:23 +08:00
print(noise.get_noise_4d(0.5, 1.9, 4.7, 0.0))
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
[/codeblock]
</description>
<tutorials>
</tutorials>
<methods>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 22:54:48 +08:00
<method name="get_image" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Image" />
<argument index="0" name="width" type="int" />
<argument index="1" name="height" type="int" />
<argument index="2" name="noise_offset" type="Vector2" default="Vector2(0, 0)" />
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
<description>
Add support for generating noise images with an offset.
2021-05-18 12:51:05 +08:00
Generate a noise image in [constant Image.FORMAT_L8] format with the requested [code]width[/code] and [code]height[/code], based on the current noise parameters. If [code]noise_offset[/code] is specified, then the offset value is used as the coordinates of the top-left corner of the generated noise.
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
</description>
</method>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 22:54:48 +08:00
<method name="get_noise_1d" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
<argument index="0" name="x" type="float" />
doc: Sync classref with current source
2019-04-15 20:49:41 +08:00
<description>
Added description to get_noise_1d() in OpenSimplexNoise
2019-06-17 15:52:48 +08:00
Returns the 1D noise value [code][-1,1][/code] at the given x-coordinate.
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
[b]Note:[/b] This method actually returns the 2D noise value [code][-1,1][/code] with fixed y-coordinate value 0.0.
doc: Sync classref with current source
2019-04-15 20:49:41 +08:00
</description>
</method>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 22:54:48 +08:00
<method name="get_noise_2d" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
<argument index="0" name="x" type="float" />
<argument index="1" name="y" type="float" />
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
<description>
Replace "persistance" with "persistence" Replace "persistance" with "persistence" in the simplex code. Also made some minor fixes to the docs.
2018-09-20 03:00:10 +08:00
Returns the 2D noise value [code][-1,1][/code] at the given position.
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
</description>
</method>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 22:54:48 +08:00
<method name="get_noise_2dv" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
<argument index="0" name="pos" type="Vector2" />
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
<description>
Replace "persistance" with "persistence" Replace "persistance" with "persistence" in the simplex code. Also made some minor fixes to the docs.
2018-09-20 03:00:10 +08:00
Returns the 2D noise value [code][-1,1][/code] at the given position.
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
</description>
</method>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 22:54:48 +08:00
<method name="get_noise_3d" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
<argument index="0" name="x" type="float" />
<argument index="1" name="y" type="float" />
<argument index="2" name="z" type="float" />
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
<description>
Replace "persistance" with "persistence" Replace "persistance" with "persistence" in the simplex code. Also made some minor fixes to the docs.
2018-09-20 03:00:10 +08:00
Returns the 3D noise value [code][-1,1][/code] at the given position.
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
</description>
</method>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 22:54:48 +08:00
<method name="get_noise_3dv" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
<argument index="0" name="pos" type="Vector3" />
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
<description>
Replace "persistance" with "persistence" Replace "persistance" with "persistence" in the simplex code. Also made some minor fixes to the docs.
2018-09-20 03:00:10 +08:00
Returns the 3D noise value [code][-1,1][/code] at the given position.
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
</description>
</method>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 22:54:48 +08:00
<method name="get_noise_4d" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
<argument index="0" name="x" type="float" />
<argument index="1" name="y" type="float" />
<argument index="2" name="z" type="float" />
<argument index="3" name="w" type="float" />
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
<description>
Replace "persistance" with "persistence" Replace "persistance" with "persistence" in the simplex code. Also made some minor fixes to the docs.
2018-09-20 03:00:10 +08:00
Returns the 4D noise value [code][-1,1][/code] at the given position.
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
</description>
</method>
doc: Sync classref with current source And fixups: - Add missing bindings in RenderingServer - Remove duplicate ArrayMesh enum bindings (they're in Mesh already) - Remove redundant _unhandled_key_input binding in Control (it's in Node already)
2020-12-04 22:54:48 +08:00
<method name="get_seamless_image" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Image" />
<argument index="0" name="size" type="int" />
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
<description>
Optimize data format for OpenSimplex images The previous RGBA format included unused RGB data. Using the LA8 format removes the need to store the extra data. The Docs have been updated to reflect the format changes.
2021-01-07 11:01:21 +08:00
Generate a tileable noise image in [constant Image.FORMAT_L8] format, based on the current noise parameters. Generated seamless images are always square ([code]size[/code] × [code]size[/code]).
Document seamless noise having a lower contrast than non-seamless noise See #41787.
2020-11-03 01:47:08 +08:00
[b]Note:[/b] Seamless noise has a lower contrast compared to non-seamless noise. This is due to the way noise uses higher dimensions for generating seamless noise.
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
</description>
</method>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="lacunarity" type="float" setter="set_lacunarity" getter="get_lacunarity" default="2.0">
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
Difference in period between [member octaves].
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="octaves" type="int" setter="set_octaves" getter="get_octaves" default="3">
Increase the maximum number of octaves in OpenSimplexNoise to 9 An error message is now printed when trying to set the number of octaves above the maximum allowed value. The magic constant was also replaced with a define that can be easily changed. This closes #28714.
2020-01-31 06:49:17 +08:00
Number of OpenSimplex noise layers that are sampled to get the fractal noise. Higher values result in more detailed noise but take more time to generate.
[b]Note:[/b] The maximum allowed value is 9.
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="period" type="float" setter="set_period" getter="get_period" default="64.0">
doc: Misc formatting fixes
2018-09-21 21:34:11 +08:00
Period of the base octave. A lower period results in a higher-frequency noise (more value changes across the same distance).
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="persistence" type="float" setter="set_persistence" getter="get_persistence" default="0.5">
doc: Misc formatting fixes
2018-09-21 21:34:11 +08:00
Contribution factor of the different octaves. A [code]persistence[/code] value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one.
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="seed" type="int" setter="set_seed" getter="get_seed" default="0">
Add SimplexNoise and NoiseTexture as new resources SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex. NoiseTexture uses SimplexNoise to generate noise textures for using in shaders/visual effects.
2018-08-25 06:25:06 +08:00
Seed used to generate random values, different seeds will generate different noise maps.
</member>
</members>
</class>
Reference in New Issue Copy Permalink