Skip to content

Added docs for camera:attach(x, y, width, height, noclip) and camera:… #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
npinochet wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −4
Open

Added docs for camera:attach(x, y, width, height, noclip) and camera:… #120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/camera.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ List of Functions
* :func:`camera:rotateTo(angle) <camera:rotateTo>`
* :func:`camera:zoom(mul) <camera:zoom>`
* :func:`camera:zoomTo(zoom) <camera:zoomTo>`
* :func:`camera:attach() <camera:attach>`
* :func:`camera:attach(x, y, width, height, noclip) <camera:attach>`
* :func:`camera:detach() <camera:detach>`
* :func:`camera:draw(func) <camera:draw>`
* :func:`camera:draw([x, y, width, height, noclip], func) <camera:draw>`
* :func:`camera:worldCoords(x, y) <camera:worldCoords>`
* :func:`camera:cameraCoords(x, y) <camera:cameraCoords>`
* :func:`camera:mousePosition() <camera:mousePosition>`
Expand Down Expand Up @@ -213,7 +213,10 @@ Set zoom: ``camera.scale = zoom``.
camera:zoomTo(1) -- reset zoom


.. function:: camera:attach()
.. function:: camera:attach(x, y, width, height, noclip)

:param numbers x,y,width,height: Defines a custom viewport, it defaults to 0, 0, love.graphics.getWidth/Height (optional).
:param boolean noclip: Whether to cut the outside of the viewport or not, it defaults to true (optional).

Start looking through the camera.

Expand Down Expand Up @@ -246,9 +249,10 @@ Stop looking through the camera.
end


.. function:: camera:draw(func)
.. function:: camera:draw([x, y, width, height, noclip], func)

:param function func: Drawing function to be wrapped.
:param numbers x,y,width,height,noclip: Same as in camera:attach (optional).

Wrap a function between a ``camera:attach()``/``camera:detach()`` pair.
Equivalent to::
Expand Down