MiniScript Wiki - User contributions [en]

PixelDisplay

2021-04-23T20:54:39Z

SicariusVelox: Correct parameters for PixelDisplay.fillPoly.

The <c>PixelDisplay</c> class in [[Mini Micro]] is a display type that represents a rectangular pixel buffer, with methods to efficiently draw lines, shapes, images, and text.

By default, [[display]] 5 is configured as a pixel display, and is in fact the pixel display to which the [[gfx]] global refers (unless you change it). But you can make any display layer a pixel display by setting its [[Display.mode|mode]] to <c>displayMode.pixel</c>.

== Methods and Properties ==

{| class="wikitable"
|-
! Method or Property !! Purpose
|-
| [[PixelDisplay.color]] || get or set the default drawing color, used when color is not otherwise specified
|-
| [[PixelDisplay.width]] || number of columns in the the pixel buffer
|-
| [[PixelDisplay.height]] || number of rows in the the pixel buffer
|-
| [[PixelDisplay.scale]] || scaling factor used to magnify (or shrink) the pixel display on screen
|-
| [[PixelDisplay.clear]] ''[color]'', ''[width]'', ''[height]'' || clear/reset the pixel buffer
|-
| [[PixelDisplay.pixel]] ''x '', ''y'' || get the color of a particular pixel
|-
| [[PixelDisplay.setPixel]] ''x'', ''y'', ''[color]'' || set the color of a particular pixel
|-
| [[PixelDisplay.scrollX]] || get or set a horizontal shift applied to the entire display
|-
| [[PixelDisplay.scrollY]] || get or set a vertical shift applied to the entire display
|-
| [[PixelDisplay.line]] ''x1'', ''y1'', ''x2'', ''y2'', ''[color]'', ''[penSize]'' || draw a line
|-
| [[PixelDisplay.drawRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw a rectangle outline
|-
| [[PixelDisplay.fillRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled rectangle
|-
| [[PixelDisplay.drawEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw an ellipse outline
|-
| [[PixelDisplay.fillEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled ellipse
|-
| [[PixelDisplay.drawPoly]] ''points'', ''[color]'', ''[penSize]'' || draw a polygon outline
|-
| [[PixelDisplay.fillPoly]] ''points'', ''[color]'' || draw a filled polygon
|-
| [[PixelDisplay.drawImage]] ''img'', ''left'', ''bottom'', ''[width]'', ''[height]'', ''[srcLeft]'', ''[srcBottom]'', ''[srcWidth]'', ''[srcHeight]'' || draw an [[Image]] (or portion thereof)
|-
| [[PixelDisplay.getImage]](''left'', ''bottom'', ''width'', ''height'') || get a portion of the pixel buffer as an [[Image]]
|-
| [[PixelDisplay.print]] ''str'', ''x'', ''y'', ''[color]'', ''[font]'' || draw a string
|}

[[Category:Mini Micro]]

Sound.waveform

2021-04-17T17:29:39Z

SicariusVelox: Initial page creation

<c>[[Sound]].waveform</c> defines the waveform that repeats based on the [[Sound]].[[Sound.freq|freq]]. It can be set a value or list of values typically from -1 to 1 (it's possible to add values outside of this range but it may lead to clipping or incorrect volume expectations.)

== Predefined Waveforms ==

the following table shows predefined waveforms included in the [[Sound]] class.

{| class="wikitable"
|-
! Waveform !! Description
|-
| [[Sound.sineWave]] || represents a sine wave (pure tone)
|-
| [[Sound.triangleWave]] || represents a triangle wave (almost pure)
|-
| [[Sound.sawtoothWave]] || represents a sawtooth wave (slightly "buzzier")
|-
| [[Sound.squareWave]] || represents a square wave (most buzzy/retro sound)
|-
| [[Sound.noiseWave]] || creates a pseudo-random "static" waveform
|}

== Examples ==
The following examples show basic uses and visual representations of each waveform.
waveform images unless specified otherwise use a [[Sound.freq|freq]] of 1 and [[Sound.duration|duration]] of 5 to show clarity.

== Sound.sineWave ==
[[File:Waveform_sinewave.png]]

the following example plays a 120hz sinewave

<ms>sine = new Sound
sine.init 1, 120, 1, Sound.sineWave
sine.play</ms>

== Sound.triangleWave ==
[[File:Waveform_triangleWave.png]]

the following example plays a 120hz triangleWave

<ms>triangle = new Sound
triangle.init 1, 120, 1, Sound.triangleWave
triangle.play</ms>

== Sound.sawtoothWave ==
[[File:Waveform_sawtoothWave.png]]

the following example plays a 120hz sawtoothWave

<ms>sawtooth = new Sound
sawtooth.init 1, 120, 1, Sound.sawtoothWave
sawtooth.play</ms>

== Sound.squareWave ==
[[File:Waveform_squareWave.png]]

the following example plays a 120hz squareWave

<ms>square = new Sound
square.init 1, 120, 1, Sound.squareWave
square.play</ms>

== Sound.noiseWave ==
[[File:Waveform_noiseWave.png]]

the following example plays a 120hz noiseWave

<ms>noise = new Sound
noise.init 1, 120, 1, Sound.noiseWave
noise.play</ms>

== Using a custom waveform ==
[[File:Waveform_trapezoidWave.png]]

the following example shows how to use a custom waveform.

<ms>
trapezoidWave = [0,1,1,1,0]
trapezoid = new Sound
trapezoid.init 1, 120, 1, trapezoidWave
trapezoid.play
</ms>

See also: <c>[[Sound.init]]</c>

[[Category:Mini Micro]]

File:Waveform trapezoidWave.png

2021-04-17T17:21:00Z

SicariusVelox: captured example demonstrating the output of a custom trapezoidal waveform.

== Summary ==
captured example demonstrating the output of a custom trapezoidal waveform.

File:Waveform noiseWave.png

2021-04-17T16:52:42Z

SicariusVelox: captured example demonstrating the output of a simple Sound.noiseWave

== Summary ==
captured example demonstrating the output of a simple Sound.noiseWave

File:Waveform squareWave.png

2021-04-17T16:52:26Z

SicariusVelox: captured example demonstrating the output of a simple Sound.squareWave

== Summary ==
captured example demonstrating the output of a simple Sound.squareWave

File:Waveform sawtoothWave.png

2021-04-17T16:52:04Z

SicariusVelox: captured example demonstrating the output of a simple Sound.sawtoothWave

== Summary ==
captured example demonstrating the output of a simple Sound.sawtoothWave

File:Waveform triangleWave.png

2021-04-17T16:46:20Z

SicariusVelox: captured example demonstrating the output of a simple Sound.triangleWave

== Summary ==
captured example demonstrating the output of a simple Sound.triangleWave

File:Waveform sinewave.png

2021-04-17T16:39:31Z

SicariusVelox: captured example demonstrating the output of a simple Sound.sineWave

== Summary ==
captured example demonstrating the output of a simple Sound.sineWave

Http.put

2021-04-17T01:30:00Z

SicariusVelox: Created page with "In Mini Micro, the http.put function sends data to a URL using the PUT method and returns the contents of the URL using the HTTP PUT protocol. It supports text, image..."

In [[Mini Micro]], the [[http]].put function sends data to a URL using the PUT method and returns the contents of the URL using the HTTP PUT protocol. It supports text, images, sounds, and raw binary data.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Meaning
|-
| url || URL of the web page or resource to fetch
|-
| data || Data to put can be a [[string]] or a [[map]]
|-
| headers || optional map of HTTP headers
|}

=== Usage Notes ===
The type of the value returned depends on the MIME type reported by the server, as follows:

{| class="wikitable"
|-
! MIME Type !! MiniScript Type
|-
| image || [[Image]] object
|-
| audio || [[Sound]] object
|-
| text, javascript, xml, or json || [[string]]
|-
| any other type || [[RawData]] object
|}

== Example ==

The following example, typed on the Mini Micro command line puts data to a URL, retrieves a response, and displays Hello World from the test site http://postman-echo.com.

Note: depending on how the server is setup to respond to put requests you may get different types of data. the below example the server responds with application/octet-stream or a list of unicode number values which we must convert back into a string.

<ms>import "json" // for json.parse
import "listUtil" // for List.apply extension
request = http.put("http://postman-echo.com/put", "Hello World")
request_data = json.parse(request)
buffer = request_data.data.data
buffer.apply(@char)
buffer.join("")
</ms>

[[Category:Mini Micro]]

Http.post

2021-04-17T01:06:59Z

SicariusVelox: added needed import statement.

In [[Mini Micro]], the [[http]].post function sends data to a URL using the POST method and returns the contents of the URL using the HTTP POST protocol. It supports text, images, sounds, and raw binary data.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Meaning
|-
| url || URL of the web page or resource to fetch
|-
| data || Data to post can be a [[string]] or a [[map]]
|-
| headers || optional map of HTTP headers
|}

=== Usage Notes ===
The type of the value returned depends on the MIME type reported by the server, as follows:

{| class="wikitable"
|-
! MIME Type !! MiniScript Type
|-
| image || [[Image]] object
|-
| audio || [[Sound]] object
|-
| text, javascript, xml, or json || [[string]]
|-
| any other type || [[RawData]] object
|}

== Example ==

The following example, typed on the Mini Micro command line posts form data, retrieves a response, and displays Hello World from the test site http://postman-echo.com.

<ms>import "json"
request = http.post("http://postman-echo.com/post", {"data":"Hello World"})
request_data = json.parse(request)
request_data.form.data
</ms>

[[Category:Mini Micro]]

Http.post

2021-04-17T00:35:40Z

SicariusVelox: Created page with "In Mini Micro, the http.post function sends data to a URL using the POST method and returns the contents of the URL using the HTTP POST protocol. It supports text, im..."

In [[Mini Micro]], the [[http]].post function sends data to a URL using the POST method and returns the contents of the URL using the HTTP POST protocol. It supports text, images, sounds, and raw binary data.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Meaning
|-
| url || URL of the web page or resource to fetch
|-
| data || Data to post can be a [[string]] or a [[map]]
|-
| headers || optional map of HTTP headers
|}

=== Usage Notes ===
The type of the value returned depends on the MIME type reported by the server, as follows:

{| class="wikitable"
|-
! MIME Type !! MiniScript Type
|-
| image || [[Image]] object
|-
| audio || [[Sound]] object
|-
| text, javascript, xml, or json || [[string]]
|-
| any other type || [[RawData]] object
|}

== Example ==

The following example, typed on the Mini Micro command line posts form data, retrieves a response, and displays Hello World from the test site http://postman-echo.com.

<ms>request = http.post("http://postman-echo.com/post", {"data":"Hello World"})
request_data = json.parse(request)
request_data.form.data
</ms>

[[Category:Mini Micro]]