Skip to content

Commit

Permalink
📝 Rename custom background screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
abe33 committed Mar 14, 2016
1 parent 407d051 commit a1ad0e4
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/Developers Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,4 @@ Type|Description|Example
`highlight-under`|Correspond to an editor `highlight` decoration that is rendered before rendering the line content.|![](https://github.com/atom-minimap/minimap/blob/master/resources/highlight-under-decorations.png?raw=true)
`highlight-over`, `highlight`|Correspond to an editor `highlight` decoration that is rendered after having rendered the line content.|![](https://github.com/atom-minimap/minimap/blob/master/resources/highlight-over-decorations.png?raw=true)
`highlight-outline`|Correspond to an editor `highlight` decoration that is rendered only as an outline in the Minimap.|![](https://github.com/atom-minimap/minimap/blob/master/resources/outline-decorations.png?raw=true)
`foreground-custom`, `background-custom`|Decorations that are rendered on a per-line basis but for which you have the control over the render routine. A custom decoration must have a `render` function provided when created. This function will receive the `Decoration` object as first argument and a render context object with the following properties: <ul><li>`context`: The canvas context onto which draw the decoration</li><li>`color`: the color for the decoration, either from its properties or from its scope</li><li>`canvasWidth`: the current width of the canvas</li><li>`canvasHeight`: the current height of the canvas</li><li>`lineHeight`: the line height in pixels scaled according to the current device pixel ratio</li><li>`charWidth`: the char width in pixels scaled according to the current device pixel ratio</li><li>`charHeight`: the char height in pixels scaled according to the current device pixel ratio</li><li>`row`: the index of the row being drawn relatively to the first rendered row</li><li>`yRow`: the y position of the row in pixels in the minimap scaled according to the current device pixel ratio</li><li>`screenRow`: the index of the row being drawn</li></ul>|Foreground: ![Over](https://github.com/atom-minimap/minimap/blob/master/resources/foreground-custom-decorations.png?raw=true)<br/>Background: ![Over](https://github.com/atom-minimap/minimap/blob/master/resources/background-custom-decorations.png?raw=true)
`foreground-custom`, `background-custom`|Decorations that are rendered on a per-line basis but for which you have the control over the render routine. A custom decoration must have a `render` function provided when created. This function will receive the `Decoration` object as first argument and a render context object with the following properties: <ul><li>`context`: The canvas context onto which draw the decoration</li><li>`color`: the color for the decoration, either from its properties or from its scope</li><li>`canvasWidth`: the current width of the canvas</li><li>`canvasHeight`: the current height of the canvas</li><li>`lineHeight`: the line height in pixels scaled according to the current device pixel ratio</li><li>`charWidth`: the char width in pixels scaled according to the current device pixel ratio</li><li>`charHeight`: the char height in pixels scaled according to the current device pixel ratio</li><li>`row`: the index of the row being drawn relatively to the first rendered row</li><li>`yRow`: the y position of the row in pixels in the minimap scaled according to the current device pixel ratio</li><li>`screenRow`: the index of the row being drawn</li></ul>|Foreground: ![Foreground](https://github.com/atom-minimap/minimap/blob/master/resources/foreground-custom-decorations.png?raw=true)<br/>Background: ![Background](https://github.com/atom-minimap/minimap/blob/master/resources/background-custom-decorations.png?raw=true)
File renamed without changes

0 comments on commit a1ad0e4

Please sign in to comment.