Skip to content

Latest commit

 

History

History
47 lines (39 loc) · 3.13 KB

sample.md

File metadata and controls

47 lines (39 loc) · 3.13 KB
Raw
weight draft
3
false

sample()

Sample cell as the {r, g, b, a, total} object literal. Used by the [sort]({{< ref "sort" >}}) algorithm. For instance LUMA sorting is implemented as follows:

// excerpt from sort
let memory1D = this.toArray();
// ...
memory1D.sort((valueA, valueB) => {
  let sa = Quadrille.sample({ value: valueA, background,
                              cellLength, textColor, textZoom });
  let sb = Quadrille.sample({ value: valueB, background,
                              cellLength, textColor, textZoom });
  let wa = 0.299 * sa.r + 0.587 * sa.g + 0.114 * sa.b;
  let wb = 0.299 * sb.r + 0.587 * sb.g + 0.114 * sb.b;
  return wa - wb;
});

Use this method to implementing other sorting criteria of the quadrille cells.

Syntax

sample([{value, imageDisplay, colorDisplay, stringDisplay, numberDisplay, arrayDisplay, objectDisplay, background, cellLength, outlineWeight, outline, textColor, textZoom}])

Parameters

parameter description
value p5.Image | p5.Graphics | p5.Color | array | object | string | number | null: empty cells
imageDisplay Function: image filled cell drawing custom procedure default is [Quadrille.imageDisplay]({{< ref "image_display" >}})
colorDisplay Function: color filled cell drawing custom procedure default is [Quadrille.colorDisplay]({{< ref "color_display" >}})
stringDisplay Function: string filled cell drawing custom procedure default is [Quadrille.stringDisplay]({{< ref "string_display" >}})
numberDisplay Function: number filled cell drawing custom procedure default is [Quadrille.numberDisplay]({{< ref "number_display" >}})
arrayDisplay Function: array filled cell drawing custom procedure
objectDisplay Function: object filled cell drawing custom procedure
background p5.Color: background sampling default is Quadrille.background
cellLength Number: cell sampling length default is quadrille [width]({{< ref "width" >}})
outlineWeight Number: edge weight default is [Quadrille.outlineWeight]({{< ref "outline_weight" >}}). Use 0 to discard all edges
outline p5.Color representation: edge color default is [Quadrille.outline]({{< ref "outline" >}})
textColor p5.Color: text sampling color default is Quadrille.textColor
textZoom Number:: text zoom level default is Quadrille.textZoom