Skip to content
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

Add missing special_flags links #2708

Merged
merged 2 commits into from
Feb 9, 2024
Merged

Add missing special_flags links #2708

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b650cb0
add missing special flags links
itzpr3d4t0r Feb 4, 2024
55375bb
moved links to newlines
itzpr3d4t0r Feb 6, 2024
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
15 changes: 4 additions & 11 deletions docs/reST/ref/surface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@
- ``area``: (optional) Specific area of the source Surface to be drawn.

``(source, dest, area, special_flags)``
- ``special_flags``: (optional) Controls the blending mode for drawing colors.
- ``special_flags``: (optional) Controls the blending mode for drawing colors. See :doc:`special_flags_list` for a list of possible values.

**Notes**

Expand Down Expand Up @@ -205,7 +205,7 @@
mode specified by special_flags. The sequence must have at least one (source, dest) pair.

:param blit_sequence: a sequence of (source, dest)
:param special_flags: the flag(s) representing the blend mode used for each surface
:param special_flags: the flag(s) representing the blend mode used for each surface. See :doc:`special_flags_list` for a list of possible values.

:returns: ``None``

Expand Down Expand Up @@ -297,15 +297,8 @@
the Alpha (A part of ``RGBA``) is ignored unless the surface uses per pixel
alpha (Surface has the ``SRCALPHA`` flag).

.. versionaddedold:: 1.8
Optional ``special_flags``: ``BLEND_ADD``, ``BLEND_SUB``,
``BLEND_MULT``, ``BLEND_MIN``, ``BLEND_MAX``.

.. versionaddedold:: 1.8.1
Optional ``special_flags``: ``BLEND_RGBA_ADD``, ``BLEND_RGBA_SUB``,
``BLEND_RGBA_MULT``, ``BLEND_RGBA_MIN``, ``BLEND_RGBA_MAX``
``BLEND_RGB_ADD``, ``BLEND_RGB_SUB``, ``BLEND_RGB_MULT``,
``BLEND_RGB_MIN``, ``BLEND_RGB_MAX``.
The special_flags argument controls how the colors are combined. See :doc:`special_flags_list`
for a list of possible values.

This will return the affected Surface area.

Expand Down