-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4a4de19
commit 087f486
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,22 @@ | ||
defmodule Vox.Format do | ||
@moduledoc """ | ||
Behaviour for representing different voxel formats. | ||
""" | ||
|
||
@doc """ | ||
Implement the behaviour creating interfaceable voxel data from an | ||
underlying voxel format. | ||
Return the interfaceable voxel data. | ||
""" | ||
@callback new(any) :: Vox.Data.t | ||
|
||
@doc """ | ||
Implement the behaviour for determining whether the data is in the | ||
format by this behaviour. | ||
If the data is in the format of this behaviour then return `true`, | ||
otherwise return `false`. | ||
""" | ||
@callback format?(any) :: boolean | ||
end |