Skip to content

Commit

Permalink
chore(deps): fixed typedoc after upgrade
Browse files Browse the repository at this point in the history
  • Loading branch information
MD4 committed Jun 2, 2021
1 parent 95331da commit 4e1ce4e
Show file tree
Hide file tree
Showing 9 changed files with 5,482 additions and 7,401 deletions.
40 changes: 21 additions & 19 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,28 @@
**[shadowed](README.md)**

> Globals
shadowed

# shadowed

## Index
## Table of contents

### Interfaces

* [Bounds](interfaces/bounds.md)
* [Segment2](interfaces/segment2.md)
* [Vec2](interfaces/vec2.md)
- [Bounds](interfaces/bounds.md)
- [Segment2](interfaces/segment2.md)
- [Vec2](interfaces/vec2.md)

### Functions

* [computeShadows](README.md#computeshadows)
- [computeShadows](README.md#computeshadows)

## Functions

### computeShadows

`Const`**computeShadows**(`bounds`: [Bounds](interfaces/bounds.md), `walls`: [Segment2](interfaces/segment2.md)[], `light`: [Vec2](interfaces/vec2.md)): [Vec2](interfaces/vec2.md)[][]

*Defined in [computeShadows.ts:39](https://github.com/MD4/shadowed/blob/3b24b55/src/computeShadows.ts#L39)*
`Const` **computeShadows**(`bounds`, `walls`, `light`): [Vec2](interfaces/vec2.md)[][]

Computes casted shadows by a light for a given set of walls within specified bounds.

**`example`**
**`example`**
```ts
computeShadows(
{
Expand All @@ -41,12 +37,18 @@ computeShadows(
);
```

#### Parameters:
#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `bounds` | [Bounds](interfaces/bounds.md) | A rectangle where the shadows will be contained. |
| `walls` | [Segment2](interfaces/segment2.md)[] | Segments that will cast shadows. |
| `light` | [Vec2](interfaces/vec2.md) | Position of the light. |

#### Returns

[Vec2](interfaces/vec2.md)[][]

Name | Type | Description |
------ | ------ | ------ |
`bounds` | [Bounds](interfaces/bounds.md) | A rectangle where the shadows will be contained. |
`walls` | [Segment2](interfaces/segment2.md)[] | Segments that will cast shadows. |
`light` | [Vec2](interfaces/vec2.md) | Position of the light. |
#### Defined in

**Returns:** [Vec2](interfaces/vec2.md)[][]
[computeShadows.ts:39](https://github.com/MD4/shadowed/blob/95331da/src/computeShadows.ts#L39)
26 changes: 12 additions & 14 deletions docs/interfaces/bounds.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,30 @@
**[shadowed](../README.md)**

> [Globals](../README.md) / Bounds
[shadowed](../README.md) / Bounds

# Interface: Bounds

## Hierarchy

* **Bounds**

## Index
## Table of contents

### Properties

* [bottomRight](bounds.md#bottomright)
* [topLeft](bounds.md#topleft)
- [bottomRight](bounds.md#bottomright)
- [topLeft](bounds.md#topleft)

## Properties

### bottomRight

**bottomRight**: [Vec2](vec2.md)
**bottomRight**: [Vec2](vec2.md)

*Defined in [entities.ts:8](https://github.com/MD4/shadowed/blob/3b24b55/src/entities.ts#L8)*
#### Defined in

[entities.ts:8](https://github.com/MD4/shadowed/blob/95331da/src/entities.ts#L8)

___

### topLeft

**topLeft**: [Vec2](vec2.md)
**topLeft**: [Vec2](vec2.md)

#### Defined in

*Defined in [entities.ts:7](https://github.com/MD4/shadowed/blob/3b24b55/src/entities.ts#L7)*
[entities.ts:7](https://github.com/MD4/shadowed/blob/95331da/src/entities.ts#L7)
26 changes: 12 additions & 14 deletions docs/interfaces/segment2.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,30 @@
**[shadowed](../README.md)**

> [Globals](../README.md) / Segment2
[shadowed](../README.md) / Segment2

# Interface: Segment2

## Hierarchy

* **Segment2**

## Index
## Table of contents

### Properties

* [a](segment2.md#a)
* [b](segment2.md#b)
- [a](segment2.md#a)
- [b](segment2.md#b)

## Properties

### a

**a**: [Vec2](vec2.md)
**a**: [Vec2](vec2.md)

*Defined in [entities.ts:12](https://github.com/MD4/shadowed/blob/3b24b55/src/entities.ts#L12)*
#### Defined in

[entities.ts:12](https://github.com/MD4/shadowed/blob/95331da/src/entities.ts#L12)

___

### b

**b**: [Vec2](vec2.md)
**b**: [Vec2](vec2.md)

#### Defined in

*Defined in [entities.ts:13](https://github.com/MD4/shadowed/blob/3b24b55/src/entities.ts#L13)*
[entities.ts:13](https://github.com/MD4/shadowed/blob/95331da/src/entities.ts#L13)
26 changes: 12 additions & 14 deletions docs/interfaces/vec2.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,30 @@
**[shadowed](../README.md)**

> [Globals](../README.md) / Vec2
[shadowed](../README.md) / Vec2

# Interface: Vec2

## Hierarchy

* **Vec2**

## Index
## Table of contents

### Properties

* [x](vec2.md#x)
* [y](vec2.md#y)
- [x](vec2.md#x)
- [y](vec2.md#y)

## Properties

### x

**x**: number
**x**: `number`

*Defined in [entities.ts:2](https://github.com/MD4/shadowed/blob/3b24b55/src/entities.ts#L2)*
#### Defined in

[entities.ts:2](https://github.com/MD4/shadowed/blob/95331da/src/entities.ts#L2)

___

### y

**y**: number
**y**: `number`

#### Defined in

*Defined in [entities.ts:3](https://github.com/MD4/shadowed/blob/3b24b55/src/entities.ts#L3)*
[entities.ts:3](https://github.com/MD4/shadowed/blob/95331da/src/entities.ts#L3)
Loading

0 comments on commit 4e1ce4e

Please sign in to comment.