Showing preview only (206K chars total). Download the full file or copy to clipboard to get everything.
Repository: devkitPro/citro2d
Branch: master
Commit: 147b02aae021
Files: 19
Total size: 197.7 KB
Directory structure:
gitextract_jjtyurv2/
├── .gitignore
├── CMakeLists.txt
├── Catnip.cmake
├── Changelog.md
├── Doxyfile
├── LICENSE
├── README.md
├── include/
│ ├── c2d/
│ │ ├── base.h
│ │ ├── font.h
│ │ ├── sprite.h
│ │ ├── spritesheet.h
│ │ └── text.h
│ └── citro2d.h
└── source/
├── base.c
├── font.c
├── internal.h
├── render2d.v.pica
├── spritesheet.c
└── text.c
================================================
FILE CONTENTS
================================================
================================================
FILE: .gitignore
================================================
*~
*.3dsx
*.elf
*.exe
*.smdh
*.gz
*.bz2
*.xz
Thumbs.db
build/
deps/
release/
debug/
lib/
bin/
docs/
.vscode/
================================================
FILE: CMakeLists.txt
================================================
cmake_minimum_required(VERSION 3.13)
project(citro2d
LANGUAGES C ASM
)
include(GNUInstallDirs)
if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
set(CMAKE_INSTALL_PREFIX "${CTR_ROOT}" CACHE PATH "" FORCE)
endif()
# Define static library target
add_library(citro2d STATIC)
set_target_properties(citro2d PROPERTIES DEBUG_POSTFIX "d")
# Add compiler flags
target_compile_options(citro2d PRIVATE
-Wall -Werror -DCITRO2D_BUILD
)
# Add include directories
target_include_directories(citro2d PRIVATE include)
target_sources(citro2d PRIVATE
source/base.c
source/font.c
source/spritesheet.c
source/text.c
)
ctr_add_shader_library(render2d
source/render2d.v.pica
)
dkp_add_embedded_binary_library(c2d_shaders
render2d
)
target_link_libraries(citro2d PRIVATE c2d_shaders)
# Install the library
install(
TARGETS citro2d
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
)
# Install headers
install(
DIRECTORY ${PROJECT_SOURCE_DIR}/include/
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
FILES_MATCHING
PATTERN "*.h"
)
================================================
FILE: Catnip.cmake
================================================
catnip_package(citro2d DEFAULT all)
catnip_add_preset(release TOOLSET 3DS BUILD_TYPE Release)
catnip_add_preset(debug TOOLSET 3DS BUILD_TYPE Debug)
================================================
FILE: Changelog.md
================================================
# Changelog
## Version 1.6.0
- Added C2D_SetTintMode: switchable tinting modes (solid tint/multiplicative tint/grayscale tint)
- Added C2D_FontSetFilter
- Minor behind-the-scenes performance improvements
- Miscellaneous bugfixes
- Further improvements to overall system stability and other minor adjustments have been made to enhance the user experience.
## Version 1.5.0
- Added for manipulating the View Transformation.
- Fixed rendering of transparent circles.
- Fixed bug affecting text parsing of empty lines.
- Further improvements to overall system stability and other minor adjustments have been made to enhance the user experience.
## Version 1.4.0
- Added text alignment and wrapping support to the text API.
- Added support for 800px wide mode.
- Further improvements to overall system stability and other minor adjustments have been made to enhance the user experience.
## Version 1.3.1
- Further improvements to overall system stability and other minor adjustments have been made to enhance the user experience.
## Version 1.3.0
- Added C2D_DrawLine (line drawing support).
- Fixed bug that resulted in incorrect rendering after certain combinations of images and untextured primitives.
- Further improvements to overall system stability and other minor adjustments have been made to enhance the user experience.
## Version 1.2.0
- Added custom font support, courtesy of @piepie62.
## Version 1.1.0
- Added proctex-powered untextured circle/ellipse rendering functions, courtesy of @Swiftloke.
- Added C2D_TextBufResize.
- Fixed bug involving sprite center being negative when setting a negative scale, and thus giving incorrect positioning.
## Version 1.0.0
Initial release.
================================================
FILE: Doxyfile
================================================
# Doxyfile 1.8.11
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
# The format is:
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = "citro2d"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER =
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF =
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
PROJECT_LOGO =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = docs
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.
ALLOW_UNICODE_NAMES = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF =
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
# description.
# The default value is: NO.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
# The default value is: NO.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = YES
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.
JAVADOC_AUTOBRIEF = YES
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.
QT_AUTOBRIEF = YES
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
# page for each member. If set to NO, the documentation of a member will be part
# of the file/class/namespace that contains it.
# The default value is: NO.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 4
# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
ALIASES =
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = YES
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
# Fortran. In the later case the parser tries to guess whether the code is fixed
# or free formatted code, this is the default for Fortran type files), VHDL. For
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
EXTENSION_MAPPING =
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = NO
# If one adds a struct or class to a group and this option is enabled, then also
# any nested class or struct is added to the same group. By default this option
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.
GROUP_NESTED_COMPOUNDS = NO
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
SUBGROUPING = YES
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically be
# useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.
TYPEDEF_HIDES_STRUCT = YES
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.
EXTRACT_PRIVATE = NO
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
EXTRACT_PACKAGE = NO
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
# included in the documentation.
# The default value is: NO.
EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
EXTRACT_LOCAL_CLASSES = NO
# This flag is only useful for Objective-C code. If set to YES, local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO, only methods in the interface are
# included.
# The default value is: NO.
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.
EXTRACT_ANON_NSPACES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO, these classes will be included in the various overviews. This option
# has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO, these declarations will be
# included in the documentation.
# The default value is: NO.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO, these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# names in lower-case letters. If set to YES, upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
# The default value is: system dependent.
CASE_SENSE_NAMES = YES
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES, the
# scope will be hidden.
# The default value is: NO.
HIDE_SCOPE_NAMES = NO
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
# append additional text to a page's title, such as Class Reference. If set to
# YES the compound reference will be hidden.
# The default value is: NO.
HIDE_COMPOUND_REFERENCE= NO
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
SHOW_INCLUDE_FILES = YES
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.
SHOW_GROUPED_MEMB_INC = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
# destructors are listed first. If set to NO the constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
SORT_BY_SCOPE_NAME = NO
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.
STRICT_PROTO_MATCHING = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
# list. This list is created by putting \todo commands in the documentation.
# The default value is: YES.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
# list. This list is created by putting \test commands in the documentation.
# The default value is: YES.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \endcond blocks.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# the bottom of the documentation of classes and structs. If set to YES, the
# list will mention the files that were used to generate the documentation.
# The default value is: YES.
SHOW_USED_FILES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE =
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
WARNINGS = YES
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = YES
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO, doxygen will only warn about wrong or incomplete
# parameter documentation, but not about the absence of documentation.
# The default value is: NO.
WARN_NO_PARAMDOC = NO
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.
# The default value is: NO.
WARN_AS_ERROR = NO
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
# error (stderr).
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = include \
README.md \
Changelog.md
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings.
# The default value is: UTF-8.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# read by doxygen.
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
FILE_PATTERNS = *.h \
*.c \
*.cpp \
*.s
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
#
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
# The default value is: NO.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS =
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
# command).
EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
EXAMPLE_PATTERNS =
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS =
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE = README.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
STRIP_CODE_COMMENTS = NO
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# function all documented functions referencing it will be listed.
# The default value is: NO.
REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the documentation.
# The default value is: YES.
REFERENCES_LINK_SOURCE = NO
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
SOURCE_TOOLTIPS = YES
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see http://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# verbatim copy of the header file for each class for which an include is
# specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
ALPHABETICAL_INDEX = YES
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
# the HTML output. If left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefore more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
# gradually make the output lighter, whereas values above 100 make the output
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
# to YES can help to show when doxygen was last run and thus if the
# documentation is up to date.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = NO
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
# Makefile in the HTML output directory. Running make will produce the docset in
# that directory and running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# for more information.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO
# This tag determines the name of the docset feed. A documentation feed provides
# an umbrella under which multiple documentation sets from a single provider
# (such as a company or product suite) can be grouped.
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Doxygen generated docs"
# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
# Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
# file. You can add a path in front of the file if the result should not be
# written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE =
# The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
# doxygen will try to run the HTML help compiler on the generated index.hhp.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION =
# The GENERATE_CHI flag controls if a separate .chi index file is generated
# (YES) or that it should be included in the master .chm file (NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING =
# The BINARY_TOC flag controls whether a binary table of contents is generated
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
# enables the Previous and Next buttons.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# the file name of the resulting .qch file. The path specified is relative to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
# folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
# filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
# The QHG_LOCATION tag can be used to specify the location of Qt's
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
# generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they form an Eclipse help plugin. To
# install this plugin and make it available under the help contents menu in
# Eclipse, the contents of the directory containing the HTML and XML files needs
# to be copied into the plugins directory of eclipse. The name of the directory
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
# After copying Eclipse needs to be restarted before the help appears.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
# value is set to YES, a side panel will be generated containing a tree-like
# index structure (just like the one that is generated for HTML Help). For this
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
# (i.e. any modern browser). Windows users are probably better off using the
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = NO
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
#
# Note that a value of 0 will completely suppress the enum values from appearing
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 1
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# to set the initial width (in pixels) of the frame in which the tree is shown.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 250
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
# output directory to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
# Note that when changing this option you need to delete any form_*.png files in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# http://www.mathjax.org) which uses client side Javascript for the rendering
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
# to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/latest/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_FORMAT = HTML-CSS
# When MathJax is enabled you need to specify the location relative to the HTML
# output directory using the MATHJAX_RELPATH option. The destination directory
# should contain the MathJax.js script. For instance, if the mathjax directory
# is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from http://www.mathjax.org before deployment.
# The default value is: http://cdn.mathjax.org/mathjax/latest.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS =
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_CODEFILE =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
# the HTML output. The underlying search engine uses javascript and DHTML and
# should work on any modern browser. Note that when using HTML help
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
# there is already a search function so this one should typically be disabled.
# For large projects the javascript based search engine can be slow, then
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
# search using the keyboard; to jump to the search box use <access key> + S
# (what the <access key> is depends on the OS and browser, but it is typically
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
# key> to jump into the search results window, the results can be navigated
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
# to select a filter and <Enter> or <escape> to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using Javascript. There
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
# setting. When disabled, doxygen will generate a PHP script for searching and
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
# and searching needs to be provided by external tools. See the section
# "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# search results.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see: http://xapian.org/). See the section "External Indexing and
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# to a relative location where the documentation can be found. The format is:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked.
#
# Note that when enabling USE_PDFLATEX this option is only used for generating
# bitmaps for formulas in the HTML output, but not in the Makefile that is
# written to the output directory.
# The default file is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used by the
# printer.
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
# by its name or with the correct syntax as to be used with the LaTeX
# \usepackage command. To get the times font for instance you can specify :
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
# To use the option intlimits with the amsmath package you can specify:
# EXTRA_PACKAGES=[intlimits]{amsmath}
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
# generated LaTeX document. The header should contain everything until the first
# chapter. If it is left blank doxygen will generate a standard header. See
# section "Doxygen usage" for information on how to let doxygen write the
# default header to a separate file.
#
# Note: Only use a user-defined header if you know what you are doing! The
# following commands have a special meaning inside the header: $title,
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
# string, for the replacement values of the other commands the user is referred
# to HTML_HEADER.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
# generated LaTeX document. The footer should contain everything after the last
# chapter. If it is left blank doxygen will generate a standard footer. See
# LATEX_HEADER for more information on how to generate a default footer and what
# special commands can be used inside the footer.
#
# Note: Only use a user-defined footer if you know what you are doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# LaTeX style sheets that are included after the standard style sheets created
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
# will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list).
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_STYLESHEET =
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the LATEX_OUTPUT output
# directory. Note that the files will be copied as-is; there are no commands or
# markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
# contain links (just like the HTML output) instead of page references. This
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
# the PDF file directly from the LaTeX files. Set this option to YES, to get a
# higher quality PDF documentation.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
# command to the generated LaTeX files. This will instruct LaTeX to keep running
# if errors occur, instead of asking the user for help. This option is also used
# when generating formulas in HTML.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
# index chapters (such as File Index, Compound Index, etc.) in the output.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
# code with syntax highlighting in the LaTeX output.
#
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_SOURCE_CODE = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
# page will contain the date and time when the page was generated. Setting this
# to NO can help when comparing the output of multiple runs.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_TIMESTAMP = NO
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
# readers/editors.
# The default value is: NO.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
# contain hyperlink fields. The RTF file will contain links (just like the HTML
# output) instead of page references. This makes the output suitable for online
# browsing using Word or some other Word compatible readers that support those
# fields.
#
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
# file, i.e. a series of assignments. You only have to provide replacements,
# missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an RTF document. Syntax is
# similar to doxygen's config file. A template extensions file can be generated
# using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
# with syntax highlighting in the RTF output.
#
# Note that which sources are shown also depends on other settings such as
# SOURCE_BROWSER.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
# classes and files.
# The default value is: NO.
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to the generated
# man pages. In case the manual section does not start with a number, the number
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3
# The MAN_SUBDIR tag determines the name of the directory created within
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
# MAN_EXTENSION with the initial . removed.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_SUBDIR =
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
# will generate one additional man file for each entity documented in the real
# man page(s). These additional files only source the real man page, but without
# them the man command would be unable to find the correct page.
# The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
# of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
# that can be used to generate PDF.
# The default value is: NO.
GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
# front of it.
# The default directory is: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
# program listings (including syntax highlighting and cross-referencing
# information) to the DOCBOOK output. Note that enabling this will significantly
# increase the size of the DOCBOOK output.
# The default value is: NO.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
# AutoGen Definitions (see http://autogen.sf.net) file that captures the
# structure of the code including all documentation. Note that this feature is
# still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
# file that captures the structure of the code including all documentation.
#
# Note that this feature is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
# output from the Perl module output.
# The default value is: NO.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
# formatted so it can be parsed by a human reader. This is useful if you want to
# understand what is going on. On the other hand, if this tag is set to NO, the
# size of the Perl module output will be much smaller and Perl will parse it
# just the same.
# The default value is: YES.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file are
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
# so different doxyrules.make files included by the same Makefile don't
# overwrite each other's variables.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
# C-preprocessor directives found in the sources and include files.
# The default value is: YES.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
# in the source code. If set to NO, only conditional compilation will be
# performed. Macro expansion can be done in a controlled way by setting
# EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
# EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
# INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by the
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
# used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that are
# defined before the preprocessor is started (similar to the -D option of e.g.
# gcc). The argument of the tag is a list of macros of the form: name or
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
# is assumed. To prevent a macro definition from being undefined via #undef or
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
# macro definition that is found in the sources will be used. Use the PREDEFINED
# tag if you want to use a different macro definition that overrules the
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have
# an all uppercase name, and do not end with a semicolon. Such function macros
# are typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
# The TAGFILES tag can be used to specify one or more tag files. For each tag
# file the location of the external documentation should be added. The format of
# a tag file without this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
# section "Linking to external documentation" for more information about the use
# of tag files.
# Note: Each tag file must have a unique name (where the name does NOT include
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
# the class index. If set to NO, only the inherited external classes will be
# listed.
# The default value is: NO.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will be
# listed.
# The default value is: YES.
EXTERNAL_GROUPS = YES
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will
# be listed.
# The default value is: YES.
EXTERNAL_PAGES = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
# disabled, but it is recommended to install and use dot, since it yields more
# powerful graphs.
# The default value is: YES.
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
# If left empty dia is assumed to be found in the default search path.
DIA_PATH =
# If set to YES the inheritance and collaboration graphs will hide inheritance
# and usage relations if the target is undocumented or is not a class.
# The default value is: YES.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
HAVE_DOT = NO
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
# processors available in the system. You can set it explicitly to a value
# larger than 0 to get control over the balance between CPU load and processing
# speed.
# Minimum value: 0, maximum value: 32, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 0
# When you want a differently looking font in the dot files that doxygen
# generates you can specify the font name using DOT_FONTNAME. You need to make
# sure dot is able to find the font, which can be done by putting it in a
# standard location or by setting the DOTFONTPATH environment variable or by
# setting DOT_FONTPATH to the directory containing the font.
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = Helvetica
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH =
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
# each documented class showing the direct and indirect inheritance relations.
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation
# dependencies (inheritance, containment, and class references variables) of the
# class with other documented classes.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = NO
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
# class node. If there are many fields or methods and many nodes the graph may
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
# number of items for each type to make the size more manageable. Set this to 0
# for no limit. Note that the threshold may be exceeded by 50% before the limit
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
# but if the number exceeds 15, the total amount of fields shown is limited to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LIMIT_NUM_FIELDS = 10
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = NO
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# YES then doxygen will generate a graph for each documented file showing the
# direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = YES
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# set to YES then doxygen will generate a graph for each documented file showing
# the direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command. Disabling a call graph can be
# accomplished by means of the command \hidecallgraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command. Disabling a caller graph can be
# accomplished by means of the command \hidecallergraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# dependencies a directory has on other directories in a graphical way. The
# dependency relations are determined by the #include relations between the
# files in the directories.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. For an explanation of the image formats see the section
# output formats in the documentation of the dot tool (Graphviz (see:
# http://www.graphviz.org/)).
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
# png:gdiplus:gdiplus.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
#
# Note that this requires a modern browser other than Internet Explorer. Tested
# and working are Firefox, Chrome, Safari, and Opera.
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
# the SVG files visible. Older versions of IE do not have SVG support.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile
# command).
MSCFILE_DIRS =
# The DIAFILE_DIRS tag can be used to specify one or more directories that
# contain dia files that are included in the documentation (see the \diafile
# command).
DIAFILE_DIRS =
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
# path where java can find the plantuml.jar file. If left blank, it is assumed
# PlantUML is not used or called during a preprocessing step. Doxygen will
# generate a warning when it encounters a \startuml command in this case and
# will not generate output for the diagram.
PLANTUML_JAR_PATH =
# When using plantuml, the specified paths are searched for files specified by
# the !include statement in a plantuml block.
PLANTUML_INCLUDE_PATH =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
# that will be shown in the graph. If the number of nodes in a graph becomes
# larger than this value, doxygen will truncate the graph, which is visualized
# by representing a node as a red box. Note that doxygen if the number of direct
# children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
# root by following a path via at most 3 edges will be shown. Nodes that lay
# further from the root node will be omitted. Note that setting this option to 1
# or 2 may greatly reduce the computation time needed for large code bases. Also
# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not seem
# to support this out of the box.
#
# Warning: Depending on the platform used, enabling this option may lead to
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
# read).
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
# this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated
# graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
# files that are used to generate the various graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_CLEANUP = YES
================================================
FILE: LICENSE
================================================
Copyright (C) 2017-2018 fincs
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any
damages arising from the use of this software.
Permission is granted to anyone to use this software for any
purpose, including commercial applications, and to alter it and
redistribute it freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you
must not claim that you wrote the original software. If you use
this software in a product, an acknowledgment in the product
documentation would be appreciated but is not required.
2. Altered source versions must be plainly marked as such, and
must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source
distribution.
================================================
FILE: README.md
================================================
# citro2d
**( ͡° ͜ʖ ͡°)**
*Library for drawing 2D graphics using the Nintendo 3DS's PICA200 GPU.*
This library contains optimized routines that allow 3DS homebrew developers to
develop applications that take full advantage of the GPU to draw 2D graphics.
The routines in this library have been carefully designed and optimized for
the purpose of removing bottlenecks and allowing higher GPU throughput.
citro2d uses [citro3d](https://github.com/fincs/citro3d) under the hood to
talk to the GPU. It is possible to use citro2d on its own, or use it alongside
citro3d to draw mixed 2D and 3D content.
Features:
- Lightweight and straightforward API
- Full doxygen documentation
- Drawing on any surface (C3D_RenderTarget)
- Drawing images and sprites (the latter contain state whereas the former don't)
- Drawing text using the system font
- Spritesheet/texture atlas support using [tex3ds](https://github.com/mtheall/tex3ds)
- Scaling, flipping, rotation
- Drawing untextured triangles and rectangles
- Per-vertex tinting with configurable blend factor (additive color blending with user specified colors)
- Flexible and configurable gradients
- Full-screen fade-out/fade-in transitions (to any color)
- Concurrent usage of citro2d and citro3d
================================================
FILE: include/c2d/base.h
================================================
/**
* @file base.h
* @brief Basic citro2d initialization and drawing API
*/
#pragma once
#include <citro3d.h>
#include <tex3ds.h>
#define C2D_DEFAULT_MAX_OBJECTS 4096
#ifdef __cplusplus
#define C2D_CONSTEXPR constexpr
#define C2D_OPTIONAL(_x) =_x
#else
#define C2D_CONSTEXPR static inline
#define C2D_OPTIONAL(_x)
#endif
typedef struct
{
struct
{
float x, y, w, h;
} pos;
struct
{
float x, y;
} center;
float depth;
float angle;
} C2D_DrawParams;
typedef enum
{
C2D_TintSolid, ///< Plain solid tint color
C2D_TintMult, ///< Tint color multiplied by texture color
C2D_TintLuma, ///< Tint color multiplied by grayscale converted texture color
C2D_TintAdd, ///< Tint color added to the texture color
C2D_TintSub, ///< Tint color subtracted from the texture color
C2D_TintOneMinusAdd, ///< 1 - Texture.rgb + tint color
C2D_TintOneMinusSub, ///< 1 - Texture.rgb - tint color
} C2D_TintMode;
typedef struct
{
u32 color; ///< RGB tint color and Alpha transparency
float blend; ///< Blending strength of the tint color (0.0~1.0)
} C2D_Tint;
typedef enum
{
C2D_TopLeft, ///< Top left corner
C2D_TopRight, ///< Top right corner
C2D_BotLeft, ///< Bottom left corner
C2D_BotRight, ///< Bottom right corner
} C2D_Corner;
typedef struct
{
C3D_Tex* tex;
const Tex3DS_SubTexture* subtex;
} C2D_Image;
typedef struct
{
C2D_Tint corners[4];
} C2D_ImageTint;
/** @defgroup Helper Helper functions
* @{
*/
/** @brief Clamps a value between bounds
* @param[in] x The value to clamp
* @param[in] min The lower bound
* @param[in] max The upper bound
* @returns The clamped value
*/
C2D_CONSTEXPR float C2D_Clamp(float x, float min, float max)
{
return x <= min ? min : x >= max ? max : x;
}
/** @brief Converts a float to u8
* @param[in] x Input value (0.0~1.0)
* @returns Output value (0~255)
*/
C2D_CONSTEXPR u8 C2D_FloatToU8(float x)
{
return (u8)(255.0f*C2D_Clamp(x, 0.0f, 1.0f)+0.5f);
}
/** @brief Builds a 32-bit RGBA color value
* @param[in] r Red component (0~255)
* @param[in] g Green component (0~255)
* @param[in] b Blue component (0~255)
* @param[in] a Alpha component (0~255)
* @returns The 32-bit RGBA color value
*/
C2D_CONSTEXPR u32 C2D_Color32(u8 r, u8 g, u8 b, u8 a)
{
return r | (g << (u32)8) | (b << (u32)16) | (a << (u32)24);
}
/** @brief Builds a 32-bit RGBA color value from float values
* @param[in] r Red component (0.0~1.0)
* @param[in] g Green component (0.0~1.0)
* @param[in] b Blue component (0.0~1.0)
* @param[in] a Alpha component (0.0~1.0)
* @returns The 32-bit RGBA color value
*/
C2D_CONSTEXPR u32 C2D_Color32f(float r, float g, float b, float a)
{
return C2D_Color32(C2D_FloatToU8(r),C2D_FloatToU8(g),C2D_FloatToU8(b),C2D_FloatToU8(a));
}
/** @brief Configures one corner of an image tint structure
* @param[in] tint Image tint structure
* @param[in] corner The corner of the image to tint
* @param[in] color RGB tint color and Alpha transparency
* @param[in] blend Blending strength of the tint color (0.0~1.0)
*/
static inline void C2D_SetImageTint(C2D_ImageTint* tint, C2D_Corner corner, u32 color, float blend)
{
tint->corners[corner].color = color;
tint->corners[corner].blend = blend;
}
/** @brief Configures an image tint structure with the specified tint parameters applied to all corners
* @param[in] tint Image tint structure
* @param[in] color RGB tint color and Alpha transparency
* @param[in] blend Blending strength of the tint color (0.0~1.0)
*/
static inline void C2D_PlainImageTint(C2D_ImageTint* tint, u32 color, float blend)
{
C2D_SetImageTint(tint, C2D_TopLeft, color, blend);
C2D_SetImageTint(tint, C2D_TopRight, color, blend);
C2D_SetImageTint(tint, C2D_BotLeft, color, blend);
C2D_SetImageTint(tint, C2D_BotRight, color, blend);
}
/** @brief Configures an image tint structure to just apply transparency to the image
* @param[in] tint Image tint structure
* @param[in] alpha Alpha transparency value to apply to the image
*/
static inline void C2D_AlphaImageTint(C2D_ImageTint* tint, float alpha)
{
C2D_PlainImageTint(tint, C2D_Color32f(0.0f, 0.0f, 0.0f, alpha), 0.0f);
}
/** @brief Configures an image tint structure with the specified tint parameters applied to the top side (e.g. for gradients)
* @param[in] tint Image tint structure
* @param[in] color RGB tint color and Alpha transparency
* @param[in] blend Blending strength of the tint color (0.0~1.0)
*/
static inline void C2D_TopImageTint(C2D_ImageTint* tint, u32 color, float blend)
{
C2D_SetImageTint(tint, C2D_TopLeft, color, blend);
C2D_SetImageTint(tint, C2D_TopRight, color, blend);
}
/** @brief Configures an image tint structure with the specified tint parameters applied to the bottom side (e.g. for gradients)
* @param[in] tint Image tint structure
* @param[in] color RGB tint color and Alpha transparency
* @param[in] blend Blending strength of the tint color (0.0~1.0)
*/
static inline void C2D_BottomImageTint(C2D_ImageTint* tint, u32 color, float blend)
{
C2D_SetImageTint(tint, C2D_BotLeft, color, blend);
C2D_SetImageTint(tint, C2D_BotRight, color, blend);
}
/** @brief Configures an image tint structure with the specified tint parameters applied to the left side (e.g. for gradients)
* @param[in] tint Image tint structure
* @param[in] color RGB tint color and Alpha transparency
* @param[in] blend Blending strength of the tint color (0.0~1.0)
*/
static inline void C2D_LeftImageTint(C2D_ImageTint* tint, u32 color, float blend)
{
C2D_SetImageTint(tint, C2D_TopLeft, color, blend);
C2D_SetImageTint(tint, C2D_BotLeft, color, blend);
}
/** @brief Configures an image tint structure with the specified tint parameters applied to the right side (e.g. for gradients)
* @param[in] tint Image tint structure
* @param[in] color RGB tint color and Alpha transparency
* @param[in] blend Blending strength of the tint color (0.0~1.0)
*/
static inline void C2D_RightImageTint(C2D_ImageTint* tint, u32 color, float blend)
{
C2D_SetImageTint(tint, C2D_TopRight, color, blend);
C2D_SetImageTint(tint, C2D_BotRight, color, blend);
}
/** @} */
/** @defgroup Base Basic functions
* @{
*/
/** @brief Initialize citro2d
* @param[in] maxObjects Maximum number of 2D objects that can be drawn per frame.
* @remarks Pass C2D_DEFAULT_MAX_OBJECTS as a starting point.
* @returns true on success, false on failure
*/
bool C2D_Init(size_t maxObjects);
/** @brief Deinitialize citro2d */
void C2D_Fini(void);
/** @brief Prepares the GPU for rendering 2D content
* @remarks This needs to be done only once in the program if citro2d is the sole user of the GPU.
*/
void C2D_Prepare(void);
/** @brief Ensures all 2D objects so far have been drawn */
void C2D_Flush(void);
/** @brief Configures the size of the 2D scene.
* @param[in] width The width of the scene, in pixels.
* @param[in] height The height of the scene, in pixels.
* @param[in] tilt Whether the scene is tilted like the 3DS's sideways screens.
*/
void C2D_SceneSize(u32 width, u32 height, bool tilt);
/** @brief Configures the size of the 2D scene to match that of the specified render target.
* @param[in] target Render target
*/
static inline void C2D_SceneTarget(C3D_RenderTarget* target)
{
C2D_SceneSize(target->frameBuf.width, target->frameBuf.height, target->linked);
}
/** @brief Resets the model transformation matrix. */
void C2D_ViewReset(void);
/** @brief Saves the current model transformation matrix.
* @param[out] matrix Pointer to save the current matrix to
*/
void C2D_ViewSave(C3D_Mtx* matrix);
/** @brief Restores a previously saved model transformation matrix.
* @param[in] matrix Pointer to matrix to restor
*/
void C2D_ViewRestore(const C3D_Mtx* matrix);
/** @brief Translates everything drawn via the model matrix.
* @param[in] x Translation in the x direction
* @param[in] y Translation in the y direction
*/
void C2D_ViewTranslate(float x, float y);
/** @brief Rotates everything drawn via the model matrix.
* @param[in] rotation Rotation in the counterclockwise direction in radians
*/
void C2D_ViewRotate(float rotation);
/** @brief Rotates everything drawn via the model matrix.
* @param[in] rotation Rotation in the counterclockwise direction in degrees
*/
static inline void C2D_ViewRotateDegrees(float rotation)
{
C2D_ViewRotate(C3D_AngleFromDegrees(rotation));
}
/** @brief Shears everything drawn via the model matrix.
* @param[in] x Shear factor in the x direction
* @param[in] y Shear factor in the y direction
*/
void C2D_ViewShear(float x, float y);
/** @brief Scales everything drawn via the model matrix.
* @param[in] x Scale factor in the x direction
* @param[in] y Scale factor in the y direction
*/
void C2D_ViewScale(float x, float y);
/** @brief Helper function to create a render target for a screen
* @param[in] screen Screen (GFX_TOP or GFX_BOTTOM)
* @param[in] side Side (GFX_LEFT or GFX_RIGHT)
* @returns citro3d render target object
*/
C3D_RenderTarget* C2D_CreateScreenTarget(gfxScreen_t screen, gfx3dSide_t side);
/** @brief Helper function to clear a rendertarget using the specified color
* @param[in] target Render target to clear
* @param[in] color 32-bit RGBA color value to fill the target with
*/
void C2D_TargetClear(C3D_RenderTarget* target, u32 color);
/** @brief Helper function to begin drawing a 2D scene on a render target
* @param[in] target Render target to draw the 2D scene to
*/
static inline void C2D_SceneBegin(C3D_RenderTarget* target)
{
C2D_Flush();
C3D_FrameDrawOn(target);
C2D_SceneTarget(target);
}
/** @} */
/** @defgroup Env Drawing environment functions
* @{
*/
/** @brief Configures the fading color
* @param[in] color 32-bit RGBA color value to be used as the fading color (0 by default)
* @remark The alpha component of the color is used as the strength of the fading color.
* If alpha is zero, the fading color has no effect. If it is the highest value,
* the rendered pixels will all have the fading color. Everything inbetween is
* rendered as a blend of the original pixel color and the fading color.
*/
bool C2D_Fade(u32 color);
/** @brief Configures the formula used to calculate the tinted texture color
* @param[in] mode Tinting mode
* @remark Texture tinting works by linearly interpolating between the regular texture color
* and the tinted texture color according to the blending strength parameter.
* This function can be used to change how the tinted texture color is precisely
* calculated, refer to \ref C2D_TintMode for a list of available tinting modes.
*/
bool C2D_SetTintMode(C2D_TintMode mode);
/** @} */
/** @defgroup Drawing Drawing functions
* @{
*/
/** @brief Draws an image using the GPU (variant accepting C2D_DrawParams)
* @param[in] img Handle of the image to draw
* @param[in] params Parameters with which to draw the image
* @param[in] tint Tint parameters to apply to the image (optional, can be null)
* @returns true on success, false on failure
*/
bool C2D_DrawImage(C2D_Image img, const C2D_DrawParams* params, const C2D_ImageTint* tint C2D_OPTIONAL(nullptr));
/** @brief Draws an image using the GPU (variant accepting position/scaling)
* @param[in] img Handle of the image to draw
* @param[in] x X coordinate at which to place the top left corner of the image
* @param[in] y Y coordinate at which to place the top left corner of the image
* @param[in] depth Depth value to draw the image with
* @param[in] tint Tint parameters to apply to the image (optional, can be null)
* @param[in] scaleX Horizontal scaling factor to apply to the image (optional, by default 1.0f); negative values apply a horizontal flip
* @param[in] scaleY Vertical scaling factor to apply to the image (optional, by default 1.0f); negative values apply a vertical flip
*/
static inline bool C2D_DrawImageAt(C2D_Image img, float x, float y, float depth,
const C2D_ImageTint* tint C2D_OPTIONAL(nullptr),
float scaleX C2D_OPTIONAL(1.0f), float scaleY C2D_OPTIONAL(1.0f))
{
C2D_DrawParams params =
{
{ x, y, scaleX*img.subtex->width, scaleY*img.subtex->height },
{ 0.0f, 0.0f },
depth, 0.0f
};
return C2D_DrawImage(img, ¶ms, tint);
}
/** @brief Draws an image using the GPU (variant accepting position/scaling/rotation)
* @param[in] img Handle of the image to draw
* @param[in] x X coordinate at which to place the center of the image
* @param[in] y Y coordinate at which to place the center of the image
* @param[in] depth Depth value to draw the image with
* @param[in] angle Angle (in radians) to rotate the image by, counter-clockwise
* @param[in] tint Tint parameters to apply to the image (optional, can be null)
* @param[in] scaleX Horizontal scaling factor to apply to the image (optional, by default 1.0f); negative values apply a horizontal flip
* @param[in] scaleY Vertical scaling factor to apply to the image (optional, by default 1.0f); negative values apply a vertical flip
*/
static inline bool C2D_DrawImageAtRotated(C2D_Image img, float x, float y, float depth, float angle,
const C2D_ImageTint* tint C2D_OPTIONAL(nullptr),
float scaleX C2D_OPTIONAL(1.0f), float scaleY C2D_OPTIONAL(1.0f))
{
C2D_DrawParams params =
{
{ x, y, scaleX*img.subtex->width, scaleY*img.subtex->height },
{ (scaleX*img.subtex->width)/2.0f, (scaleY*img.subtex->height)/2.0f },
depth, angle
};
return C2D_DrawImage(img, ¶ms, tint);
}
/** @brief Draws a plain triangle using the GPU
* @param[in] x0 X coordinate of the first vertex of the triangle
* @param[in] y0 Y coordinate of the first vertex of the triangle
* @param[in] clr0 32-bit RGBA color of the first vertex of the triangle
* @param[in] x1 X coordinate of the second vertex of the triangle
* @param[in] y1 Y coordinate of the second vertex of the triangle
* @param[in] clr1 32-bit RGBA color of the second vertex of the triangle
* @param[in] x2 X coordinate of the third vertex of the triangle
* @param[in] y2 Y coordinate of the third vertex of the triangle
* @param[in] clr2 32-bit RGBA color of the third vertex of the triangle
* @param[in] depth Depth value to draw the triangle with
*/
bool C2D_DrawTriangle(
float x0, float y0, u32 clr0,
float x1, float y1, u32 clr1,
float x2, float y2, u32 clr2,
float depth);
/** @brief Draws a plain line using the GPU
* @param[in] x0 X coordinate of the first vertex of the line
* @param[in] y0 Y coordinate of the first vertex of the line
* @param[in] clr0 32-bit RGBA color of the first vertex of the line
* @param[in] x1 X coordinate of the second vertex of the line
* @param[in] y1 Y coordinate of the second vertex of the line
* @param[in] clr1 32-bit RGBA color of the second vertex of the line
* @param[in] thickness Thickness, in pixels, of the line
* @param[in] depth Depth value to draw the line with
*/
bool C2D_DrawLine(
float x0, float y0, u32 clr0,
float x1, float y1, u32 clr1,
float thickness, float depth);
/** @brief Draws a plain rectangle using the GPU
* @param[in] x X coordinate of the top-left vertex of the rectangle
* @param[in] y Y coordinate of the top-left vertex of the rectangle
* @param[in] z Z coordinate (depth value) to draw the rectangle with
* @param[in] w Width of the rectangle
* @param[in] h Height of the rectangle
* @param[in] clr0 32-bit RGBA color of the top-left corner of the rectangle
* @param[in] clr1 32-bit RGBA color of the top-right corner of the rectangle
* @param[in] clr2 32-bit RGBA color of the bottom-left corner of the rectangle
* @param[in] clr3 32-bit RGBA color of the bottom-right corner of the rectangle
*/
bool C2D_DrawRectangle(
float x, float y, float z, float w, float h,
u32 clr0, u32 clr1, u32 clr2, u32 clr3);
/** @brief Draws a plain rectangle using the GPU (with a solid color)
* @param[in] x X coordinate of the top-left vertex of the rectangle
* @param[in] y Y coordinate of the top-left vertex of the rectangle
* @param[in] z Z coordinate (depth value) to draw the rectangle with
* @param[in] w Width of the rectangle
* @param[in] h Height of the rectangle
* @param[in] clr 32-bit RGBA color of the rectangle
*/
static inline bool C2D_DrawRectSolid(
float x, float y, float z, float w, float h,
u32 clr)
{
return C2D_DrawRectangle(x,y,z,w,h,clr,clr,clr,clr);
}
/** @brief Draws an ellipse using the GPU
* @param[in] x X coordinate of the top-left vertex of the ellipse
* @param[in] y Y coordinate of the top-left vertex of the ellipse
* @param[in] z Z coordinate (depth value) to draw the ellipse with
* @param[in] w Width of the ellipse
* @param[in] h Height of the ellipse
* @param[in] clr0 32-bit RGBA color of the top-left corner of the ellipse
* @param[in] clr1 32-bit RGBA color of the top-right corner of the ellipse
* @param[in] clr2 32-bit RGBA color of the bottom-left corner of the ellipse
* @param[in] clr3 32-bit RGBA color of the bottom-right corner of the ellipse
* @note Switching to and from "circle mode" internally requires an expensive state change. As such, the recommended usage of this feature is to draw all non-circular objects first, then draw all circular objects.
*/
bool C2D_DrawEllipse(
float x, float y, float z, float w, float h,
u32 clr0, u32 clr1, u32 clr2, u32 clr3);
/** @brief Draws a ellipse using the GPU (with a solid color)
* @param[in] x X coordinate of the top-left vertex of the ellipse
* @param[in] y Y coordinate of the top-left vertex of the ellipse
* @param[in] z Z coordinate (depth value) to draw the ellipse with
* @param[in] w Width of the ellipse
* @param[in] h Height of the ellipse
* @param[in] clr 32-bit RGBA color of the ellipse
* @note Switching to and from "circle mode" internally requires an expensive state change. As such, the recommended usage of this feature is to draw all non-circular objects first, then draw all circular objects.
*/
static inline bool C2D_DrawEllipseSolid(
float x, float y, float z, float w, float h,
u32 clr)
{
return C2D_DrawEllipse(x,y,z,w,h,clr,clr,clr,clr);
}
/** @brief Draws a circle (an ellipse with identical width and height) using the GPU
* @param[in] x X coordinate of the center of the circle
* @param[in] y Y coordinate of the center of the circle
* @param[in] z Z coordinate (depth value) to draw the ellipse with
* @param[in] radius Radius of the circle
* @param[in] clr0 32-bit RGBA color of the top-left corner of the ellipse
* @param[in] clr1 32-bit RGBA color of the top-right corner of the ellipse
* @param[in] clr2 32-bit RGBA color of the bottom-left corner of the ellipse
* @param[in] clr3 32-bit RGBA color of the bottom-right corner of the ellipse
* @note Switching to and from "circle mode" internally requires an expensive state change. As such, the recommended usage of this feature is to draw all non-circular objects first, then draw all circular objects.
*/
static inline bool C2D_DrawCircle(
float x, float y, float z, float radius,
u32 clr0, u32 clr1, u32 clr2, u32 clr3)
{
return C2D_DrawEllipse(
x - radius,y - radius,z,radius*2,radius*2,
clr0,clr1,clr2,clr3);
}
/** @brief Draws a circle (an ellipse with identical width and height) using the GPU (with a solid color)
* @param[in] x X coordinate of the center of the circle
* @param[in] y Y coordinate of the center of the circle
* @param[in] z Z coordinate (depth value) to draw the ellipse with
* @param[in] radius Radius of the circle
* @param[in] clr 32-bit RGBA color of the ellipse
* @note Switching to and from "circle mode" internally requires an expensive state change. As such, the recommended usage of this feature is to draw all non-circular objects first, then draw all circular objects.
*/
static inline bool C2D_DrawCircleSolid(
float x, float y, float z, float radius,
u32 clr)
{
return C2D_DrawCircle(x,y,z,radius,clr,clr,clr,clr);
}
/** @} */
================================================
FILE: include/c2d/font.h
================================================
/**
* @file font.h
* @brief Font loading and management
*/
#pragma once
#include "base.h"
struct C2D_Font_s;
typedef struct C2D_Font_s* C2D_Font;
/** @defgroup Font Font functions
* @{
*/
/** @brief Load a font from a file
* @param[in] filename Name of the font file (.bcfnt)
* @returns Font handle
* @retval NULL Error
*/
C2D_Font C2D_FontLoad(const char* filename);
/** @brief Load a font from memory
* @param[in] data Data to load
* @param[in] size Size of the data to load
* @returns Font handle
* @retval NULL Error
*/
C2D_Font C2D_FontLoadFromMem(const void* data, size_t size);
/** @brief Load a font from file descriptor
* @param[in] fd File descriptor used to load data
* @returns Font handle
* @retval NULL Error
*/
C2D_Font C2D_FontLoadFromFD(int fd);
/** @brief Load font from stdio file handle
* @param[in] f File handle used to load data
* @returns Font handle
* @retval NULL Error
*/
C2D_Font C2D_FontLoadFromHandle(FILE* f);
/** @brief Load corresponding font from system archive
* @param[in] region Region to get font from
* @returns Font handle
* @retval NULL Error
* @remark JPN, USA, EUR, and AUS all use the same font.
*/
C2D_Font C2D_FontLoadSystem(CFG_Region region);
/** @brief Free a font
* @param[in] font Font handle
*/
void C2D_FontFree(C2D_Font font);
/** @brief Set a font's texture filter
* @param[in] font Font handle
* @param[in] magFilter the magnification filter
* @param[in] minFilter the minification filter
*/
void C2D_FontSetFilter(C2D_Font font, GPU_TEXTURE_FILTER_PARAM magFilter, GPU_TEXTURE_FILTER_PARAM minFilter);
/** @brief Find the glyph index of a codepoint, or returns the default
* @param[in] font Font to search, or NULL for system font
* @param[in] codepoint Codepoint to search for
* @returns Glyph index
* @retval font->cfnt->finf.alterCharIndex The codepoint does not exist in the font
*/
int C2D_FontGlyphIndexFromCodePoint(C2D_Font font, u32 codepoint);
/** @brief Get character width info for a given index
* @param[in] font Font to read from, or NULL for system font
* @param[in] glyphIndex Index to get the width of
* @returns Width info for glyph
*/
charWidthInfo_s* C2D_FontGetCharWidthInfo(C2D_Font font, int glyphIndex);
/** @brief Calculate glyph position of given index
* @param[in] font Font to read from, or NULL for system font
* @param[out] out Glyph position
* @param[in] glyphIndex Index to get position of
* @param[in] flags Misc flags
* @param[in] scaleX Size to scale in X
* @param[in] scaleY Size to scale in Y
*/
void C2D_FontCalcGlyphPos(C2D_Font font, fontGlyphPos_s* out, int glyphIndex, u32 flags, float scaleX, float scaleY);
/** @brief Get the font info structure associated with the font
* @param[in] font Font to read from, or NULL for the system font
* @returns FINF associated with the font
*/
FINF_s* C2D_FontGetInfo(C2D_Font font);
/** @} */
================================================
FILE: include/c2d/sprite.h
================================================
/**
* @file sprite.h
* @brief Stateful sprite API
*/
#pragma once
#include "spritesheet.h"
typedef struct
{
C2D_Image image;
C2D_DrawParams params;
} C2D_Sprite;
/** @defgroup Sprite Sprite functions
* @{
*/
/** @brief Initializes a sprite from an image
* @param[in] Pointer to sprite
* @param[in] image Image to use
*/
static inline void C2D_SpriteFromImage(C2D_Sprite* sprite, C2D_Image image)
{
sprite->image = image;
sprite->params.pos.x = 0.0f;
sprite->params.pos.y = 0.0f;
sprite->params.pos.w = image.subtex->width;
sprite->params.pos.h = image.subtex->height;
sprite->params.center.x = 0.0f;
sprite->params.center.y = 0.0f;
sprite->params.angle = 0.0f;
sprite->params.depth = 0.0f;
}
/** @brief Initializes a sprite from an image stored in a sprite sheet
* @param[in] Pointer to sprite
* @param[in] sheet Sprite sheet handle
* @param[in] index Index of the image inside the sprite sheet
*/
static inline void C2D_SpriteFromSheet(C2D_Sprite* sprite, C2D_SpriteSheet sheet, size_t index)
{
C2D_SpriteFromImage(sprite, C2D_SpriteSheetGetImage(sheet, index));
}
/** @brief Scale sprite (relative)
* @param[in] sprite Pointer to sprite
* @param[in] x X scale (negative values flip the sprite horizontally)
* @param[in] y Y scale (negative values flip the sprite vertically)
*/
static inline void C2D_SpriteScale(C2D_Sprite* sprite, float x, float y)
{
sprite->params.pos.w *= x;
sprite->params.pos.h *= y;
sprite->params.center.x *= x;
sprite->params.center.y *= y;
}
/** @brief Rotate sprite (relative)
* @param[in] sprite Pointer to sprite
* @param[in] radians Amount to rotate in radians
*/
static inline void C2D_SpriteRotate(C2D_Sprite* sprite, float radians)
{
sprite->params.angle += radians;
}
/** @brief Rotate sprite (relative)
* @param[in] sprite Pointer to sprite
* @param[in] degrees Amount to rotate in degrees
*/
static inline void C2D_SpriteRotateDegrees(C2D_Sprite* sprite, float degrees)
{
C2D_SpriteRotate(sprite, C3D_AngleFromDegrees(degrees));
}
/** @brief Move sprite (relative)
* @param[in] sprite Pointer to sprite
* @param[in] x X translation
* @param[in] y Y translation
*/
static inline void C2D_SpriteMove(C2D_Sprite* sprite, float x, float y)
{
sprite->params.pos.x += x;
sprite->params.pos.y += y;
}
/** @brief Scale sprite (absolute)
* @param[in] sprite Pointer to sprite
* @param[in] x X scale (negative values flip the sprite horizontally)
* @param[in] y Y scale (negative values flip the sprite vertically)
*/
static inline void C2D_SpriteSetScale(C2D_Sprite* sprite, float x, float y)
{
float oldCenterX = sprite->params.center.x / sprite->params.pos.w;
float oldCenterY = sprite->params.center.y / sprite->params.pos.h;
sprite->params.pos.w = x*sprite->image.subtex->width;
sprite->params.pos.h = y*sprite->image.subtex->height;
sprite->params.center.x = fabsf(oldCenterX*sprite->params.pos.w);
sprite->params.center.y = fabsf(oldCenterY*sprite->params.pos.h);
}
/** @brief Rotate sprite (absolute)
* @param[in] sprite Pointer to sprite
* @param[in] radians Amount to rotate in radians
*/
static inline void C2D_SpriteSetRotation(C2D_Sprite* sprite, float radians)
{
sprite->params.angle = radians;
}
/** @brief Rotate sprite (absolute)
* @param[in] sprite Pointer to sprite
* @param[in] degrees Amount to rotate in degrees
*/
static inline void C2D_SpriteSetRotationDegrees(C2D_Sprite* sprite, float degrees)
{
C2D_SpriteSetRotation(sprite, C3D_AngleFromDegrees(degrees));
}
/** @brief Set the center of a sprite in values independent of the sprite size (absolute)
* @param[in] sprite Pointer to sprite
* @param[in] x X position of the center (0.0 through 1.0)
* @param[in] y Y position of the center (0.0 through 1.0)
*/
static inline void C2D_SpriteSetCenter(C2D_Sprite* sprite, float x, float y)
{
sprite->params.center.x = x*sprite->params.pos.w;
sprite->params.center.y = y*sprite->params.pos.h;
}
/** @brief Set the center of a sprite in terms of pixels (absolute)
* @param[in] sprite Pointer to sprite
* @param[in] x X position of the center (in pixels)
* @param[in] y Y position of the center (in pixels)
*/
static inline void C2D_SpriteSetCenterRaw(C2D_Sprite* sprite, float x, float y)
{
sprite->params.center.x = x;
sprite->params.center.y = y;
}
/** @brief Move sprite (absolute)
* @param[in] sprite Pointer to sprite
* @param[in] x X position
* @param[in] y Y position
*/
static inline void C2D_SpriteSetPos(C2D_Sprite* sprite, float x, float y)
{
sprite->params.pos.x = x;
sprite->params.pos.y = y;
}
/** @brief Sets the depth level of a sprite (absolute)
* @param[in] sprite Pointer to sprite
* @param[in] depth Depth value
*/
static inline void C2D_SpriteSetDepth(C2D_Sprite* sprite, float depth)
{
sprite->params.depth = depth;
}
/** @brief Draw sprite
* @param[in] sprite Sprite to draw
*/
static inline bool C2D_DrawSprite(const C2D_Sprite* sprite)
{
return C2D_DrawImage(sprite->image, &sprite->params, NULL);
}
/** @brief Draw sprite with color tinting
* @param[in] sprite Sprite to draw
* @param[in] tint Color tinting parameters to apply to the sprite
*/
static inline bool C2D_DrawSpriteTinted(const C2D_Sprite* sprite, const C2D_ImageTint* tint)
{
return C2D_DrawImage(sprite->image, &sprite->params, tint);
}
/** @} */
================================================
FILE: include/c2d/spritesheet.h
================================================
/**
* @file spritesheet.h
* @brief Spritesheet (texture atlas) loading and management
*/
#pragma once
#include "base.h"
struct C2D_SpriteSheet_s;
typedef struct C2D_SpriteSheet_s* C2D_SpriteSheet;
/** @defgroup SpriteSheet Sprite sheet functions
* @{
*/
/** @brief Load a sprite sheet from file
* @param[in] filename Name of the sprite sheet file (.t3x)
* @returns Sprite sheet handle
* @retval NULL Error
*/
C2D_SpriteSheet C2D_SpriteSheetLoad(const char* filename);
/** @brief Load a sprite sheet from memory
* @param[in] data Data to load
* @param[in] size Size of the data to load
* @returns Sprite sheet handle
* @retval NULL Error
*/
C2D_SpriteSheet C2D_SpriteSheetLoadFromMem(const void* data, size_t size);
/** @brief Load sprite sheet from file descriptor
* @param[in] fd File descriptor used to load data
* @returns Sprite sheet handle
* @retval NULL Error
*/
C2D_SpriteSheet C2D_SpriteSheetFromFD(int fd);
/** @brief Load sprite sheet from stdio file handle
* @param[in] f File handle used to load data
* @returns Sprite sheet handle
* @retval NULL Error
*/
C2D_SpriteSheet C2D_SpriteSheetLoadFromHandle(FILE* f);
/** @brief Free a sprite sheet
* @param[in] sheet Sprite sheet handle
*/
void C2D_SpriteSheetFree(C2D_SpriteSheet sheet);
/** @brief Retrieves the number of sprites in the specified sprite sheet
* @param[in] sheet Sprite sheet handle
* @returns Number of sprites
*/
size_t C2D_SpriteSheetCount(C2D_SpriteSheet sheet);
/** @brief Retrieves the specified image from the specified sprite sheet
* @param[in] sheet Sprite sheet handle
* @param[in] index Index of the image to retrieve
* @returns Image object
*/
C2D_Image C2D_SpriteSheetGetImage(C2D_SpriteSheet sheet, size_t index);
/** @} */
================================================
FILE: include/c2d/text.h
================================================
/**
* @file text.h
* @brief Text rendering API
*/
#pragma once
#include "base.h"
#include "font.h"
struct C2D_TextBuf_s;
typedef struct C2D_TextBuf_s* C2D_TextBuf;
/** @defgroup Text Text drawing functions
* @{
*/
/// Text object.
typedef struct
{
C2D_TextBuf buf; ///< Buffer associated with the text.
size_t begin; ///< Reserved for internal use.
size_t end; ///< Reserved for internal use.
float width; ///< Width of the text in pixels, according to 1x scale metrics.
u32 lines; ///< Number of lines in the text.
u32 words; ///< Number of words in the text.
C2D_Font font; ///< Font used to draw the text, or NULL for system font
} C2D_Text;
enum
{
C2D_AtBaseline = BIT(0), ///< Matches the Y coordinate with the baseline of the font.
C2D_WithColor = BIT(1), ///< Draws text with color. Requires a u32 color value.
C2D_AlignLeft = 0 << 2, ///< Draws text aligned to the left. This is the default.
C2D_AlignRight = 1 << 2, ///< Draws text aligned to the right.
C2D_AlignCenter = 2 << 2, ///< Draws text centered.
C2D_AlignJustified = 3 << 2, ///< Draws text justified. When C2D_WordWrap is not specified, right edge is x + scaleX*text->width. Otherwise, right edge is x + the width specified for those values.
C2D_AlignMask = 3 << 2, ///< Bitmask for alignment values.
C2D_WordWrap = BIT(4), ///< Draws text with wrapping of full words before specified width. Requires a float value, passed after color if C2D_WithColor is specified.
};
/** @brief Creates a new text buffer.
* @param[in] maxGlyphs Maximum number of glyphs that can be stored in the buffer.
* @returns Text buffer handle (or NULL on failure).
*/
C2D_TextBuf C2D_TextBufNew(size_t maxGlyphs);
/** @brief Resizes a text buffer.
* @param[in] buf Text buffer to resize.
* @param[in] maxGlyphs Maximum number of glyphs that can be stored in the buffer.
* @returns New text buffer handle (or NULL on failure).
* @remarks If successful, old text buffer handle becomes invalid.
*/
C2D_TextBuf C2D_TextBufResize(C2D_TextBuf buf, size_t maxGlyphs);
/** @brief Deletes a text buffer.
* @param[in] buf Text buffer handle.
* @remarks This also invalidates all text objects previously created with this buffer.
*/
void C2D_TextBufDelete(C2D_TextBuf buf);
/** @brief Clears all stored text in a buffer.
* @param[in] buf Text buffer handle.
*/
void C2D_TextBufClear(C2D_TextBuf buf);
/** @brief Retrieves the number of glyphs stored in a text buffer.
* @param[in] buf Text buffer handle.
* @returns The number of glyphs.
*/
size_t C2D_TextBufGetNumGlyphs(C2D_TextBuf buf);
/** @brief Parses and adds a single line of text to a text buffer.
* @param[out] text Pointer to text object to store information in.
* @param[in] buf Text buffer handle.
* @param[in] str String to parse.
* @param[in] lineNo Line number assigned to the text (used to calculate vertical position).
* @remarks Whitespace doesn't add any glyphs to the text buffer and is thus "free".
* @returns On success, a pointer to the character on which string processing stopped, which
* can be a newline ('\n'; indicating that's where the line ended), the null character
* ('\0'; indicating the end of the string was reached), or any other character
* (indicating the text buffer is full and no more glyphs can be added).
* On failure, NULL.
*/
const char* C2D_TextParseLine(C2D_Text* text, C2D_TextBuf buf, const char* str, u32 lineNo);
/** @brief Parses and adds a single line of text to a text buffer.
* @param[out] text Pointer to text object to store information in.
* @param[in] font Font to get glyphs from, or null for system font
* @param[in] buf Text buffer handle.
* @param[in] str String to parse.
* @param[in] lineNo Line number assigned to the text (used to calculate vertical position).
* @remarks Whitespace doesn't add any glyphs to the text buffer and is thus "free".
* @returns On success, a pointer to the character on which string processing stopped, which
* can be a newline ('\n'; indicating that's where the line ended), the null character
* ('\0'; indicating the end of the string was reached), or any other character
* (indicating the text buffer is full and no more glyphs can be added).
* On failure, NULL.
*/
const char* C2D_TextFontParseLine(C2D_Text* text, C2D_Font font, C2D_TextBuf buf, const char* str, u32 lineNo);
/** @brief Parses and adds arbitrary text (including newlines) to a text buffer.
* @param[out] text Pointer to text object to store information in.
* @param[in] buf Text buffer handle.
* @param[in] str String to parse.
* @remarks Whitespace doesn't add any glyphs to the text buffer and is thus "free".
* @returns On success, a pointer to the character on which string processing stopped, which
* can be the null character ('\0'; indicating the end of the string was reached),
* or any other character (indicating the text buffer is full and no more glyphs can be added).
* On failure, NULL.
*/
const char* C2D_TextParse(C2D_Text* text, C2D_TextBuf buf, const char* str);
/** @brief Parses and adds arbitrary text (including newlines) to a text buffer.
* @param[out] text Pointer to text object to store information in.
* @param[in] font Font to get glyphs from, or null for system font
* @param[in] buf Text buffer handle.
* @param[in] str String to parse.
* @remarks Whitespace doesn't add any glyphs to the text buffer and is thus "free".
* @returns On success, a pointer to the character on which string processing stopped, which
* can be the null character ('\0'; indicating the end of the string was reached),
* or any other character (indicating the text buffer is full and no more glyphs can be added).
* On failure, NULL.
*/
const char* C2D_TextFontParse(C2D_Text* text, C2D_Font font, C2D_TextBuf buf, const char* str);
/** @brief Optimizes a text object in order to be drawn more efficiently.
* @param[in] text Pointer to text object.
*/
void C2D_TextOptimize(const C2D_Text* text);
/** @brief Retrieves the total dimensions of a text object.
* @param[in] text Pointer to text object.
* @param[in] scaleX Horizontal size of the font. 1.0f corresponds to the native size of the font.
* @param[in] scaleY Vertical size of the font. 1.0f corresponds to the native size of the font.
* @param[out] outWidth (optional) Variable in which to store the width of the text.
* @param[out] outHeight (optional) Variable in which to store the height of the text.
*/
void C2D_TextGetDimensions(const C2D_Text* text, float scaleX, float scaleY, float* outWidth, float* outHeight);
/** @brief Draws text using the GPU.
* @param[in] text Pointer to text object.
* @param[in] flags Text drawing flags.
* @param[in] x Horizontal position to draw the text on.
* @param[in] y Vertical position to draw the text on. If C2D_AtBaseline is not specified (default), this
* is the top left corner of the block of text; otherwise this is the position of the baseline
* of the first line of text.
* @param[in] z Depth value of the text. If unsure, pass 0.0f.
* @param[in] scaleX Horizontal size of the font. 1.0f corresponds to the native size of the font.
* @param[in] scaleY Vertical size of the font. 1.0f corresponds to the native size of the font.
* @remarks The default 3DS system font has a glyph height of 30px, and the baseline is at 25px.
*/
void C2D_DrawText(const C2D_Text* text, u32 flags, float x, float y, float z, float scaleX, float scaleY, ...);
/** @} */
================================================
FILE: include/citro2d.h
================================================
/**
* @file citro2d.h
* @brief Central citro2d header. Includes all others.
*/
#pragma once
#ifdef CITRO2D_BUILD
#error "This header file is only for external users of citro2d."
#endif
#ifdef __cplusplus
extern "C" {
#endif
#include <citro3d.h>
#include <tex3ds.h>
#include "c2d/base.h"
#include "c2d/spritesheet.h"
#include "c2d/sprite.h"
#include "c2d/text.h"
#include "c2d/font.h"
#ifdef __cplusplus
}
#endif
================================================
FILE: source/base.c
================================================
#include "internal.h"
#include "render2d_shbin.h"
C2Di_Context __C2Di_Context;
static C3D_Mtx s_projTop, s_projBot;
static int uLoc_mdlvMtx, uLoc_projMtx;
static inline bool C2Di_CheckBufSpace(C2Di_Context* ctx, unsigned idx, unsigned vtx)
{
size_t free_idx = ctx->idxBufSize - ctx->idxBufPos;
size_t free_vtx = ctx->vtxBufSize - ctx->vtxBufPos;
return free_idx >= idx && free_vtx >= vtx;
}
static void C2Di_FrameEndHook(void* unused)
{
C2Di_Context* ctx = C2Di_GetContext();
C2Di_FlushVtxBuf();
ctx->vtxBufPos = 0;
ctx->idxBufPos = 0;
ctx->idxBufLastPos = 0;
}
bool C2D_Init(size_t maxObjects)
{
C2Di_Context* ctx = C2Di_GetContext();
if (ctx->flags & C2DiF_Active)
return false;
ctx->vtxBufSize = 4*maxObjects;
ctx->vtxBuf = (C2Di_Vertex*)linearAlloc(ctx->vtxBufSize*sizeof(C2Di_Vertex));
if (!ctx->vtxBuf)
return false;
ctx->idxBufSize = 6*maxObjects;
ctx->idxBuf = (u16*)linearAlloc(ctx->idxBufSize*sizeof(u16));
if (!ctx->idxBuf)
{
linearFree(ctx->vtxBuf);
return false;
}
ctx->shader = DVLB_ParseFile((u32*)render2d_shbin, render2d_shbin_size);
if (!ctx->shader)
{
linearFree(ctx->idxBuf);
linearFree(ctx->vtxBuf);
return false;
}
shaderProgramInit(&ctx->program);
shaderProgramSetVsh(&ctx->program, &ctx->shader->DVLE[0]);
AttrInfo_Init(&ctx->attrInfo);
AttrInfo_AddLoader(&ctx->attrInfo, 0, GPU_FLOAT, 3); // v0=position
AttrInfo_AddLoader(&ctx->attrInfo, 1, GPU_FLOAT, 2); // v1=texcoord
AttrInfo_AddLoader(&ctx->attrInfo, 2, GPU_FLOAT, 2); // v2=blend
AttrInfo_AddLoader(&ctx->attrInfo, 3, GPU_UNSIGNED_BYTE, 4); // v3=color
BufInfo_Init(&ctx->bufInfo);
BufInfo_Add(&ctx->bufInfo, ctx->vtxBuf, sizeof(C2Di_Vertex), 4, 0x3210);
// Cache these common projection matrices
Mtx_OrthoTilt(&s_projTop, 0.0f, 400.0f, 240.0f, 0.0f, 1.0f, -1.0f, true);
Mtx_OrthoTilt(&s_projBot, 0.0f, 320.0f, 240.0f, 0.0f, 1.0f, -1.0f, true);
// Get uniform locations
uLoc_mdlvMtx = shaderInstanceGetUniformLocation(ctx->program.vertexShader, "mdlvMtx");
uLoc_projMtx = shaderInstanceGetUniformLocation(ctx->program.vertexShader, "projMtx");
// Prepare proctex
C3D_ProcTexInit(&ctx->ptBlend, 0, 1);
C3D_ProcTexClamp(&ctx->ptBlend, GPU_PT_CLAMP_TO_EDGE, GPU_PT_CLAMP_TO_EDGE);
C3D_ProcTexCombiner(&ctx->ptBlend, true, GPU_PT_U, GPU_PT_V);
C3D_ProcTexFilter(&ctx->ptBlend, GPU_PT_LINEAR);
C3D_ProcTexInit(&ctx->ptCircle, 0, 1);
C3D_ProcTexClamp(&ctx->ptCircle, GPU_PT_MIRRORED_REPEAT, GPU_PT_MIRRORED_REPEAT);
C3D_ProcTexCombiner(&ctx->ptCircle, true, GPU_PT_SQRT2, GPU_PT_SQRT2);
C3D_ProcTexFilter(&ctx->ptCircle, GPU_PT_LINEAR);
// Prepare proctex lut
float data[129];
int i;
for (i = 0; i <= 128; i ++)
data[i] = i/128.0f;
ProcTexLut_FromArray(&ctx->ptBlendLut, data);
for (i = 0; i <= 128; i ++)
data[i] = (i >= 127) ? 0 : 1;
ProcTexLut_FromArray(&ctx->ptCircleLut, data);
ctx->flags = C2DiF_Active | (C2DiF_Mode_ImageSolid << (C2DiF_TintMode_Shift-C2DiF_Mode_Shift));
ctx->vtxBufPos = 0;
ctx->idxBufPos = 0;
ctx->idxBufLastPos = 0;
Mtx_Identity(&ctx->projMtx);
Mtx_Identity(&ctx->mdlvMtx);
ctx->fadeClr = 0;
C3D_FrameEndHook(C2Di_FrameEndHook, NULL);
return true;
}
void C2D_Fini(void)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return;
ctx->flags = 0;
C3D_FrameEndHook(NULL, NULL);
shaderProgramFree(&ctx->program);
DVLB_Free(ctx->shader);
linearFree(ctx->idxBuf);
linearFree(ctx->vtxBuf);
}
void C2D_Prepare(void)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return;
ctx->flags = (ctx->flags &~ (C2DiF_Mode_Mask|C2DiF_ProcTex_Mask)) | C2DiF_DirtyAny;
ctx->curTex = NULL;
C3D_BindProgram(&ctx->program);
C3D_SetAttrInfo(&ctx->attrInfo);
C3D_SetBufInfo(&ctx->bufInfo);
// texenv usage:
// 0..4: used by switchable mode
// 5..6: used by post processing
C3D_TexEnv* env;
// Configure texenv4 as a no-op (reserved)
env = C3D_GetTexEnv(4);
C3D_TexEnvInit(env);
// Configure texenv5 to apply the fade color
// texenv5.rgb = mix(texenv4.rgb, fadeclr.rgb, fadeclr.a);
// texenv5.a = texenv4.a;
env = C3D_GetTexEnv(5);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_RGB, GPU_PREVIOUS, GPU_CONSTANT, GPU_CONSTANT);
C3D_TexEnvOpRgb(env, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_ONE_MINUS_SRC_ALPHA);
C3D_TexEnvFunc(env, C3D_RGB, GPU_INTERPOLATE);
C3D_TexEnvColor(env, ctx->fadeClr);
// Configure depth test to overwrite pixels with the same depth (needed to draw overlapping sprites)
C3D_DepthTest(true, GPU_GEQUAL, GPU_WRITE_ALL);
// Don't cull anything
C3D_CullFace(GPU_CULL_NONE);
}
void C2D_Flush(void)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return;
C2Di_FlushVtxBuf();
}
void C2D_SceneSize(u32 width, u32 height, bool tilt)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return;
if (tilt)
{
u32 temp = width;
width = height;
height = temp;
}
ctx->flags |= C2DiF_DirtyProj;
ctx->sceneW = width;
ctx->sceneH = height;
// Check for cached projection matrices
if (height == GSP_SCREEN_WIDTH && tilt)
{
if (width == GSP_SCREEN_HEIGHT_TOP || width == GSP_SCREEN_HEIGHT_TOP_2X)
{
Mtx_Copy(&ctx->projMtx, &s_projTop);
return;
}
else if (width == GSP_SCREEN_HEIGHT_BOTTOM)
{
Mtx_Copy(&ctx->projMtx, &s_projBot);
return;
}
}
// Construct the projection matrix
(tilt ? Mtx_OrthoTilt : Mtx_Ortho)(&ctx->projMtx, 0.0f, width, height, 0.0f, 1.0f, -1.0f, true);
}
void C2D_ViewReset(void)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return;
Mtx_Identity(&ctx->mdlvMtx);
ctx->flags |= C2DiF_DirtyMdlv;
}
void C2D_ViewSave(C3D_Mtx* matrix)
{
C2Di_Context* ctx = C2Di_GetContext();
Mtx_Copy(matrix, &ctx->mdlvMtx);
}
void C2D_ViewRestore(const C3D_Mtx* matrix)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return;
Mtx_Copy(&ctx->mdlvMtx, matrix);
ctx->flags |= C2DiF_DirtyMdlv;
}
void C2D_ViewTranslate(float x, float y)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return;
Mtx_Translate(&ctx->mdlvMtx, x, y, 0.0f, true);
ctx->flags |= C2DiF_DirtyMdlv;
}
void C2D_ViewRotate(float radians)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return;
Mtx_RotateZ(&ctx->mdlvMtx, radians, true);
ctx->flags |= C2DiF_DirtyMdlv;
}
void C2D_ViewShear(float x, float y)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return;
C3D_Mtx mult;
Mtx_Identity(&mult);
mult.r[0].y = x;
mult.r[1].x = y;
Mtx_Multiply(&ctx->mdlvMtx, &ctx->mdlvMtx, &mult);
ctx->flags |= C2DiF_DirtyMdlv;
}
void C2D_ViewScale(float x, float y)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return;
Mtx_Scale(&ctx->mdlvMtx, x, y, 1.0f);
ctx->flags |= C2DiF_DirtyMdlv;
}
C3D_RenderTarget* C2D_CreateScreenTarget(gfxScreen_t screen, gfx3dSide_t side)
{
int height;
switch (screen)
{
default:
case GFX_BOTTOM:
height = GSP_SCREEN_HEIGHT_BOTTOM;
break;
case GFX_TOP:
height = !gfxIsWide() ? GSP_SCREEN_HEIGHT_TOP : GSP_SCREEN_HEIGHT_TOP_2X;
break;
}
C3D_RenderTarget* target = C3D_RenderTargetCreate(GSP_SCREEN_WIDTH, height, GPU_RB_RGBA8, GPU_RB_DEPTH16);
if (target)
C3D_RenderTargetSetOutput(target, screen, side,
GX_TRANSFER_FLIP_VERT(0) | GX_TRANSFER_OUT_TILED(0) | GX_TRANSFER_RAW_COPY(0) |
GX_TRANSFER_IN_FORMAT(GX_TRANSFER_FMT_RGBA8) | GX_TRANSFER_OUT_FORMAT(GX_TRANSFER_FMT_RGB8) |
GX_TRANSFER_SCALING(GX_TRANSFER_SCALE_NO));
return target;
}
void C2D_TargetClear(C3D_RenderTarget* target, u32 color)
{
C2Di_FlushVtxBuf();
C3D_FrameSplit(0);
C3D_RenderTargetClear(target, C3D_CLEAR_ALL, __builtin_bswap32(color), 0);
}
bool C2D_Fade(u32 color)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return false;
ctx->flags |= C2DiF_DirtyFade;
ctx->fadeClr = color;
return true;
}
bool C2D_SetTintMode(C2D_TintMode mode)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return false;
u32 new_mode;
switch (mode)
{
default:
case C2D_TintSolid:
new_mode = C2DiF_Mode_ImageSolid;
break;
case C2D_TintMult:
new_mode = C2DiF_Mode_ImageMult;
break;
case C2D_TintLuma:
new_mode = C2DiF_Mode_ImageLuma;
break;
case C2D_TintAdd:
new_mode = C2DiF_Mode_ImageAdd;
break;
case C2D_TintSub:
new_mode = C2DiF_Mode_ImageSub;
break;
case C2D_TintOneMinusAdd:
new_mode = C2DiF_Mode_ImageOMAdd;
break;
case C2D_TintOneMinusSub:
new_mode = C2DiF_Mode_ImageOMSub;
break;
}
ctx->flags = (ctx->flags &~ C2DiF_TintMode_Mask) | (new_mode << (C2DiF_TintMode_Shift - C2DiF_Mode_Shift));
return true;
}
static inline void C2Di_RotatePoint(float* point, float rsin, float rcos)
{
float x = point[0] * rcos - point[1] * rsin;
float y = point[1] * rcos + point[0] * rsin;
point[0] = x;
point[1] = y;
}
static inline void C2Di_SwapUV(float* a, float* b)
{
float temp[2] = { a[0], a[1] };
a[0] = b[0];
a[1] = b[1];
b[0] = temp[0];
b[1] = temp[1];
}
void C2Di_CalcQuad(C2Di_Quad* quad, const C2D_DrawParams* params)
{
const float w = fabs(params->pos.w);
const float h = fabs(params->pos.h);
quad->topLeft[0] = -params->center.x;
quad->topLeft[1] = -params->center.y;
quad->topRight[0] = -params->center.x+w;
quad->topRight[1] = -params->center.y;
quad->botLeft[0] = -params->center.x;
quad->botLeft[1] = -params->center.y+h;
quad->botRight[0] = -params->center.x+w;
quad->botRight[1] = -params->center.y+h;
if (params->angle != 0.0f)
{
float rsin = sinf(params->angle);
float rcos = cosf(params->angle);
C2Di_RotatePoint(quad->topLeft, rsin, rcos);
C2Di_RotatePoint(quad->topRight, rsin, rcos);
C2Di_RotatePoint(quad->botLeft, rsin, rcos);
C2Di_RotatePoint(quad->botRight, rsin, rcos);
}
quad->topLeft[0] += params->pos.x;
quad->topLeft[1] += params->pos.y;
quad->topRight[0] += params->pos.x;
quad->topRight[1] += params->pos.y;
quad->botLeft[0] += params->pos.x;
quad->botLeft[1] += params->pos.y;
quad->botRight[0] += params->pos.x;
quad->botRight[1] += params->pos.y;
}
bool C2D_DrawImage(C2D_Image img, const C2D_DrawParams* params, const C2D_ImageTint* tint)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return false;
if (!C2Di_CheckBufSpace(ctx, 6, 4))
return false;
C2Di_SetMode((ctx->flags & C2DiF_TintMode_Mask) >> (C2DiF_TintMode_Shift - C2DiF_Mode_Shift));
C2Di_SetTex(img.tex);
C2Di_Update();
// Calculate positions
C2Di_Quad quad;
C2Di_CalcQuad(&quad, params);
// Calculate texcoords
float tcTopLeft[2], tcTopRight[2], tcBotLeft[2], tcBotRight[2];
Tex3DS_SubTextureTopLeft (img.subtex, &tcTopLeft[0], &tcTopLeft[1]);
Tex3DS_SubTextureTopRight (img.subtex, &tcTopRight[0], &tcTopRight[1]);
Tex3DS_SubTextureBottomLeft (img.subtex, &tcBotLeft[0], &tcBotLeft[1]);
Tex3DS_SubTextureBottomRight(img.subtex, &tcBotRight[0], &tcBotRight[1]);
// Perform flip if needed
if (params->pos.w < 0)
{
C2Di_SwapUV(tcTopLeft, tcTopRight);
C2Di_SwapUV(tcBotLeft, tcBotRight);
}
if (params->pos.h < 0)
{
C2Di_SwapUV(tcTopLeft, tcBotLeft);
C2Di_SwapUV(tcTopRight, tcBotRight);
}
// Calculate colors
static const C2D_Tint s_defaultTint = { 0xFF<<24, 0.0f };
const C2D_Tint* tintTopLeft = tint ? &tint->corners[C2D_TopLeft] : &s_defaultTint;
const C2D_Tint* tintTopRight = tint ? &tint->corners[C2D_TopRight] : &s_defaultTint;
const C2D_Tint* tintBotLeft = tint ? &tint->corners[C2D_BotLeft] : &s_defaultTint;
const C2D_Tint* tintBotRight = tint ? &tint->corners[C2D_BotRight] : &s_defaultTint;
C2Di_AppendQuad();
C2Di_AppendVtx(quad.topLeft[0], quad.topLeft[1], params->depth, tcTopLeft[0], tcTopLeft[1], 0, tintTopLeft->blend, tintTopLeft->color);
C2Di_AppendVtx(quad.topRight[0], quad.topRight[1], params->depth, tcTopRight[0], tcTopRight[1], 0, tintTopRight->blend, tintTopRight->color);
C2Di_AppendVtx(quad.botLeft[0], quad.botLeft[1], params->depth, tcBotLeft[0], tcBotLeft[1], 0, tintBotLeft->blend, tintBotLeft->color);
C2Di_AppendVtx(quad.botRight[0], quad.botRight[1], params->depth, tcBotRight[0], tcBotRight[1], 0, tintBotRight->blend, tintBotRight->color);
return true;
}
bool C2D_DrawTriangle(float x0, float y0, u32 clr0, float x1, float y1, u32 clr1, float x2, float y2, u32 clr2, float depth)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return false;
if (!C2Di_CheckBufSpace(ctx, 3, 3))
return false;
C2Di_SetMode(C2DiF_Mode_Solid);
C2Di_Update();
C2Di_AppendTri();
C2Di_AppendVtx(x0, y0, depth, 0.0f, 0.0f, 0.0f, 0.0f, clr0);
C2Di_AppendVtx(x1, y1, depth, 0.0f, 0.0f, 0.0f, 0.0f, clr1);
C2Di_AppendVtx(x2, y2, depth, 0.0f, 0.0f, 0.0f, 0.0f, clr2);
return true;
}
bool C2D_DrawLine(float x0, float y0, u32 clr0, float x1, float y1, u32 clr1, float thickness, float depth)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return false;
if (!C2Di_CheckBufSpace(ctx, 6, 4))
return false;
float dx = x1-x0, dy = y1-y0, len = sqrtf(dx*dx+dy*dy), th = thickness/2;
float ux = (-dy/len)*th, uy = (dx/len)*th;
float px0 = x0-ux, py0 = y0-uy, px1 = x0+ux, py1 = y0+uy, px2 = x1+ux, py2 = y1+uy, px3 = x1-ux, py3 = y1-uy;
C2Di_SetMode(C2DiF_Mode_Solid);
C2Di_Update();
C2Di_AppendQuad();
C2Di_AppendVtx(px0, py0, depth, 0.0f, 0.0f, 0.0f, 0.0f, clr0);
C2Di_AppendVtx(px3, py3, depth, 0.0f, 0.0f, 0.0f, 0.0f, clr1);
C2Di_AppendVtx(px1, py1, depth, 0.0f, 0.0f, 0.0f, 0.0f, clr0);
C2Di_AppendVtx(px2, py2, depth, 0.0f, 0.0f, 0.0f, 0.0f, clr1);
return true;
}
bool C2D_DrawRectangle(float x, float y, float z, float w, float h, u32 clr0, u32 clr1, u32 clr2, u32 clr3)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return false;
if (!C2Di_CheckBufSpace(ctx, 6, 4))
return false;
C2Di_SetMode(C2DiF_Mode_Solid);
C2Di_Update();
C2Di_AppendQuad();
C2Di_AppendVtx(x, y, z, 0.0f, 0.0f, 0.0f, 0.0f, clr0);
C2Di_AppendVtx(x+w, y, z, 0.0f, 0.0f, 0.0f, 0.0f, clr1);
C2Di_AppendVtx(x, y+h, z, 0.0f, 0.0f, 0.0f, 0.0f, clr2);
C2Di_AppendVtx(x+w, y+h, z, 0.0f, 0.0f, 0.0f, 0.0f, clr3);
return true;
}
bool C2D_DrawEllipse(float x, float y, float z, float w, float h, u32 clr0, u32 clr1, u32 clr2, u32 clr3)
{
C2Di_Context* ctx = C2Di_GetContext();
if (!(ctx->flags & C2DiF_Active))
return false;
if (!C2Di_CheckBufSpace(ctx, 6, 4))
return false;
C2Di_SetMode(C2DiF_Mode_Circle);
C2Di_Update();
C2Di_AppendQuad();
C2Di_AppendVtx(x, y, z, 0.0f, 0.0f, -1.0f, -1.0f, clr0);
C2Di_AppendVtx(x+w, y, z, 0.0f, 0.0f, 1.0f, -1.0f, clr1);
C2Di_AppendVtx(x, y+h, z, 0.0f, 0.0f, -1.0f, 1.0f, clr2);
C2Di_AppendVtx(x+w, y+h, z, 0.0f, 0.0f, 1.0f, 1.0f, clr3);
return true;
}
void C2Di_AppendTri(void)
{
C2Di_Context* ctx = C2Di_GetContext();
u16* idx = &ctx->idxBuf[ctx->idxBufPos];
ctx->idxBufPos += 3;
*idx++ = ctx->vtxBufPos+0;
*idx++ = ctx->vtxBufPos+1;
*idx++ = ctx->vtxBufPos+2;
}
void C2Di_AppendQuad(void)
{
C2Di_Context* ctx = C2Di_GetContext();
u16* idx = &ctx->idxBuf[ctx->idxBufPos];
ctx->idxBufPos += 6;
*idx++ = ctx->vtxBufPos+0;
*idx++ = ctx->vtxBufPos+2;
*idx++ = ctx->vtxBufPos+1;
*idx++ = ctx->vtxBufPos+1;
*idx++ = ctx->vtxBufPos+2;
*idx++ = ctx->vtxBufPos+3;
}
void C2Di_AppendVtx(float x, float y, float z, float u, float v, float ptx, float pty, u32 color)
{
C2Di_Context* ctx = C2Di_GetContext();
C2Di_Vertex* vtx = &ctx->vtxBuf[ctx->vtxBufPos++];
vtx->pos[0] = x;
vtx->pos[1] = y;
vtx->pos[2] = z;
vtx->texcoord[0] = u;
vtx->texcoord[1] = v;
vtx->ptcoord[0] = ptx;
vtx->ptcoord[1] = pty;
vtx->color = color;
}
void C2Di_FlushVtxBuf(void)
{
C2Di_Context* ctx = C2Di_GetContext();
size_t len = ctx->idxBufPos - ctx->idxBufLastPos;
if (!len) return;
C3D_DrawElements(GPU_TRIANGLES, len, C3D_UNSIGNED_SHORT, &ctx->idxBuf[ctx->idxBufLastPos]);
ctx->idxBufLastPos = ctx->idxBufPos;
}
void C2Di_Update(void)
{
C2Di_Context* ctx = C2Di_GetContext();
u32 flags = ctx->flags & C2DiF_DirtyAny;
if (!flags) return;
C2Di_FlushVtxBuf();
if (flags & C2DiF_DirtyProj)
C3D_FVUnifMtx4x4(GPU_VERTEX_SHADER, uLoc_projMtx, &ctx->projMtx);
if (flags & C2DiF_DirtyMdlv)
C3D_FVUnifMtx4x4(GPU_VERTEX_SHADER, uLoc_mdlvMtx, &ctx->mdlvMtx);
if (flags & C2DiF_DirtyTex)
C3D_TexBind(0, ctx->curTex);
if (flags & C2DiF_DirtyFade)
C3D_TexEnvColor(C3D_GetTexEnv(5), ctx->fadeClr);
u32 mode = ctx->flags & C2DiF_Mode_Mask;
u32 proctex = C2DiF_ProcTex_None;
C3D_TexEnv* env;
if (flags & C2DiF_DirtyMode) switch (mode)
{
case C2DiF_Mode_Solid:
{
// Plain ol' passthrough of vertex color.
env = C3D_GetTexEnv(0);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_Both, GPU_PRIMARY_COLOR, 0, 0);
C3D_TexEnvFunc(env, C3D_Both, GPU_REPLACE);
// Reset unused texenv stages
C3D_TexEnvInit(C3D_GetTexEnv(1));
C3D_TexEnvInit(C3D_GetTexEnv(2));
C3D_TexEnvInit(C3D_GetTexEnv(3));
break;
}
case C2DiF_Mode_Circle:
case C2DiF_Mode_Text:
{
GPU_TEVSRC alphamask = GPU_TEXTURE0;
if (mode == C2DiF_Mode_Circle)
{
// Generate a circle shaped alpha mask (u^2 + v^2 < 1) using proctex.
proctex = C2DiF_ProcTex_Circle;
alphamask = GPU_TEXTURE3;
}
// texenv0.rgb = vtxcolor.rgb
// texenv0.a = vtxcolor.a * alphamask
env = C3D_GetTexEnv(0);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_RGB, GPU_PRIMARY_COLOR, 0, 0);
C3D_TexEnvFunc(env, C3D_RGB, GPU_REPLACE);
C3D_TexEnvSrc(env, C3D_Alpha, GPU_PRIMARY_COLOR, alphamask, 0);
C3D_TexEnvFunc(env, C3D_Alpha, GPU_MODULATE);
// Reset unused texenv stages
C3D_TexEnvInit(C3D_GetTexEnv(1));
C3D_TexEnvInit(C3D_GetTexEnv(2));
C3D_TexEnvInit(C3D_GetTexEnv(3));
break;
}
case C2DiF_Mode_ImageSolid:
{
// Use texenv to blend the color source with the solid tint color,
// according to a parameter that is passed through with the help of proctex.
proctex = C2DiF_ProcTex_Blend;
// texenv0.rgb = mix(texclr.rgb, vtxcolor.rgb, vtx.blend.y);
// texenv0.a = texclr.a * vtxcolor.a
env = C3D_GetTexEnv(0);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_RGB, GPU_TEXTURE0, GPU_PRIMARY_COLOR, GPU_TEXTURE3);
C3D_TexEnvOpRgb(env, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_ONE_MINUS_SRC_ALPHA);
C3D_TexEnvFunc(env, C3D_RGB, GPU_INTERPOLATE);
C3D_TexEnvSrc(env, C3D_Alpha, GPU_TEXTURE0, GPU_PRIMARY_COLOR, 0);
C3D_TexEnvFunc(env, C3D_Alpha, GPU_MODULATE);
// Reset unused texenv stages
C3D_TexEnvInit(C3D_GetTexEnv(1));
C3D_TexEnvInit(C3D_GetTexEnv(2));
C3D_TexEnvInit(C3D_GetTexEnv(3));
break;
}
case C2DiF_Mode_ImageMult:
{
// Use texenv to blend the color source with the multiply-tinted version of it,
// according to a parameter that is passed through with the help of proctex.
proctex = C2DiF_ProcTex_Blend;
// texenv0 = texclr * vtxcolor
env = C3D_GetTexEnv(0);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_Both, GPU_TEXTURE0, GPU_PRIMARY_COLOR, 0);
C3D_TexEnvFunc(env, C3D_Both, GPU_MODULATE);
// texenv1.rgb = mix(texclr.rgb, texenv0.rgb, vtx.blend.y);
env = C3D_GetTexEnv(1);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_RGB, GPU_TEXTURE0, GPU_PREVIOUS, GPU_TEXTURE3);
C3D_TexEnvOpRgb(env, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_ONE_MINUS_SRC_ALPHA);
C3D_TexEnvFunc(env, C3D_RGB, GPU_INTERPOLATE);
// Reset unused texenv stages
C3D_TexEnvInit(C3D_GetTexEnv(2));
C3D_TexEnvInit(C3D_GetTexEnv(3));
break;
}
case C2DiF_Mode_ImageLuma:
{
// Use texenv to blend the color source with the grayscale/tinted version of it,
// according to a parameter that is passed through with the help of proctex.
proctex = C2DiF_ProcTex_Blend;
// texenv0.rgb = 0.5*texclr.rgb + 0.5
// texenv0.a = texclr.a * vtxcolor.a
env = C3D_GetTexEnv(0);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_RGB, GPU_TEXTURE0, GPU_CONSTANT, GPU_CONSTANT);
C3D_TexEnvFunc(env, C3D_RGB, GPU_MULTIPLY_ADD);
C3D_TexEnvSrc(env, C3D_Alpha, GPU_TEXTURE0, GPU_PRIMARY_COLOR, 0);
C3D_TexEnvFunc(env, C3D_Alpha, GPU_MODULATE);
C3D_TexEnvColor(env, 0x808080);
// K_grayscale = 0.5*vec3(0.299, 0.587, 0.114) + 0.5
// texenv1.rgb = 4*dot(texenv0.rgb - 0.5, K_grayscale - 0.5)
env = C3D_GetTexEnv(1);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_RGB, GPU_PREVIOUS, GPU_CONSTANT, 0);
C3D_TexEnvFunc(env, C3D_RGB, GPU_DOT3_RGB);
C3D_TexEnvColor(env, 0x8ecaa6);
// texenv2.rgb = texenv1.rgb * vtxcolor.rgb
env = C3D_GetTexEnv(2);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_RGB, GPU_PREVIOUS, GPU_PRIMARY_COLOR, 0);
C3D_TexEnvFunc(env, C3D_RGB, GPU_MODULATE);
// texenv3.rgb = mix(texclr.rgb, texenv2.rgb, vtx.blend.y);
env = C3D_GetTexEnv(3);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_RGB, GPU_TEXTURE0, GPU_PREVIOUS, GPU_TEXTURE3);
C3D_TexEnvOpRgb(env, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_ONE_MINUS_SRC_ALPHA);
C3D_TexEnvFunc(env, C3D_RGB, GPU_INTERPOLATE);
break;
}
case C2DiF_Mode_ImageAdd:
case C2DiF_Mode_ImageOMAdd:
{
// Use texenv to blend the color source with the addition-tinted version of it,
// according to a parameter that is passed through with the help of proctex.
proctex = C2DiF_ProcTex_Blend;
// texenv0 = texclr + vtxcolor
// texenv0 = (1-texclr) + vtxcolor
env = C3D_GetTexEnv(0);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_RGB, GPU_TEXTURE0, GPU_PRIMARY_COLOR, GPU_PRIMARY_COLOR);
if (mode == C2DiF_Mode_ImageOMAdd){ // if OM set to ONE MINUS
C3D_TexEnvOpRgb(env, GPU_TEVOP_RGB_ONE_MINUS_SRC_COLOR, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_ONE_MINUS_SRC_ALPHA);
}
C3D_TexEnvFunc(env, C3D_RGB, GPU_ADD);
// texenv1.rgb = mix(texclr.rgb, texenv0.rgb, vtx.blend.y);
env = C3D_GetTexEnv(1);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_Both, GPU_TEXTURE0, GPU_PREVIOUS, GPU_TEXTURE3);
C3D_TexEnvOpRgb(env, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_ONE_MINUS_SRC_ALPHA);
C3D_TexEnvFunc(env, C3D_RGB, GPU_INTERPOLATE);
// Reset unused texenv stages
C3D_TexEnvInit(C3D_GetTexEnv(2));
C3D_TexEnvInit(C3D_GetTexEnv(3));
break;
}
case C2DiF_Mode_ImageSub:
case C2DiF_Mode_ImageOMSub:
{
// Use texenv to blend the color source with the subtraction-tinted version of it,
// according to a parameter that is passed through with the help of proctex.
proctex = C2DiF_ProcTex_Blend;
// texenv0 = texclr - vtxcolor
// texenv0 = (1-texclr) - vtxcolor
env = C3D_GetTexEnv(0);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_RGB, GPU_TEXTURE0, GPU_PRIMARY_COLOR, GPU_PRIMARY_COLOR);
if (mode == C2DiF_Mode_ImageOMSub){ // if OM set to ONE MINUS
C3D_TexEnvOpRgb(env, GPU_TEVOP_RGB_ONE_MINUS_SRC_COLOR, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_ONE_MINUS_SRC_ALPHA);
}
C3D_TexEnvFunc(env, C3D_RGB, GPU_SUBTRACT);
// texenv1.rgb = mix(texclr.rgb, texenv0.rgb, vtx.blend.y);
env = C3D_GetTexEnv(1);
C3D_TexEnvInit(env);
C3D_TexEnvSrc(env, C3D_Both, GPU_TEXTURE0, GPU_PREVIOUS, GPU_TEXTURE3);
C3D_TexEnvOpRgb(env, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_SRC_COLOR, GPU_TEVOP_RGB_ONE_MINUS_SRC_ALPHA);
C3D_TexEnvFunc(env, C3D_RGB, GPU_INTERPOLATE);
// Reset unused texenv stages
C3D_TexEnvInit(C3D_GetTexEnv(2));
C3D_TexEnvInit(C3D_GetTexEnv(3));
break;
}
}
if (proctex && proctex != (ctx->flags & C2DiF_ProcTex_Mask))
{
ctx->flags = (ctx->flags &~ C2DiF_ProcTex_Mask) | proctex;
switch (proctex)
{
case C2DiF_ProcTex_Blend:
C3D_ProcTexBind(1, &ctx->ptBlend);
C3D_ProcTexLutBind(GPU_LUT_ALPHAMAP, &ctx->ptBlendLut);
break;
case C2DiF_ProcTex_Circle:
C3D_ProcTexBind(1, &ctx->ptCircle);
C3D_ProcTexLutBind(GPU_LUT_ALPHAMAP, &ctx->ptCircleLut);
break;
}
}
ctx->flags &= ~C2DiF_DirtyAny;
}
================================================
FILE: source/font.c
================================================
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include "internal.h"
#include <c2d/font.h>
C2D_Font C2D_FontLoad(const char* filename)
{
FILE* f = fopen(filename, "rb");
if (!f) return NULL;
C2D_Font ret = C2D_FontLoadFromHandle(f);
fclose(f);
return ret;
}
static inline C2D_Font C2Di_FontAlloc(void)
{
return (C2D_Font)malloc(sizeof(struct C2D_Font_s));
}
static C2D_Font C2Di_PostLoadFont(C2D_Font font)
{
if (!font->cfnt)
{
free(font);
font = NULL;
} else
{
fontFixPointers(font->cfnt);
TGLP_s* glyphInfo = font->cfnt->finf.tglp;
font->glyphSheets = malloc(sizeof(C3D_Tex)*glyphInfo->nSheets);
font->textScale = 30.0f / glyphInfo->cellHeight;
if (!font->glyphSheets)
{
C2D_FontFree(font);
return NULL;
}
int i;
for (i = 0; i < glyphInfo->nSheets; i++)
{
C3D_Tex* tex = &font->glyphSheets[i];
tex->data = &glyphInfo->sheetData[glyphInfo->sheetSize*i];
tex->fmt = glyphInfo->sheetFmt;
tex->size = glyphInfo->sheetSize;
tex->width = glyphInfo->sheetWidth;
tex->height = glyphInfo->sheetHeight;
tex->param = GPU_TEXTURE_MAG_FILTER(GPU_LINEAR) | GPU_TEXTURE_MIN_FILTER(GPU_LINEAR)
| GPU_TEXTURE_WRAP_S(GPU_CLAMP_TO_BORDER) | GPU_TEXTURE_WRAP_T(GPU_CLAMP_TO_BORDER);
tex->border = 0;
tex->lodParam = 0;
}
}
return font;
}
C2D_Font C2D_FontLoadFromMem(const void* data, size_t size)
{
C2D_Font font = C2Di_FontAlloc();
if (font)
{
font->cfnt = linearAlloc(size);
if (font->cfnt)
memcpy(font->cfnt, data, size);
font = C2Di_PostLoadFont(font);
}
return font;
}
C2D_Font C2D_FontLoadFromFD(int fd)
{
C2D_Font font = C2Di_FontAlloc();
if (font)
{
CFNT_s cfnt;
read(fd, &cfnt, sizeof(CFNT_s));
font->cfnt = linearAlloc(cfnt.fileSize);
if (font->cfnt)
{
memcpy(font->cfnt, &cfnt, sizeof(CFNT_s));
read(fd, (u8*)(font->cfnt) + sizeof(CFNT_s), cfnt.fileSize - sizeof(CFNT_s));
}
font = C2Di_PostLoadFont(font);
}
return font;
}
C2D_Font C2D_FontLoadFromHandle(FILE* handle)
{
C2D_Font font = C2Di_FontAlloc();
if (font)
{
CFNT_s cfnt;
fread(&cfnt, 1, sizeof(CFNT_s), handle);
font->cfnt = linearAlloc(cfnt.fileSize);
if (font->cfnt)
{
memcpy(font->cfnt, &cfnt, sizeof(CFNT_s));
fread((u8*)(font->cfnt) + sizeof(CFNT_s), 1, cfnt.fileSize - sizeof(CFNT_s), handle);
}
font = C2Di_PostLoadFont(font);
}
return font;
}
static C2D_Font C2Di_FontLoadFromArchive(u64 tid, const char* path)
{
void* fontLzData = NULL;
u32 fontLzSize = 0;
Result rc = romfsMountFromTitle(tid, MEDIATYPE_NAND, "font");
if (R_FAILED(rc))
return NULL;
FILE* f = fopen(path, "rb");
if (f)
{
fseek(f, 0, SEEK_END);
fontLzSize = ftell(f);
rewind(f);
fontLzData = malloc(fontLzSize);
if (fontLzData)
fread(fontLzData, 1, fontLzSize, f);
fclose(f);
}
romfsUnmount("font");
if (!fontLzData)
return NULL;
C2D_Font font = C2Di_FontAlloc();
if (!font)
{
free(fontLzData);
return NULL;
}
u32 fontSize = *(u32*)fontLzData >> 8;
font->cfnt = linearAlloc(fontSize);
if (font->cfnt && !decompress_LZ11(font->cfnt, fontSize, NULL, (u8*)fontLzData + 4, fontLzSize - 4))
{
linearFree(font->cfnt);
font->cfnt = NULL;
}
free(fontLzData);
return C2Di_PostLoadFont(font);
}
static unsigned C2Di_RegionToFontIndex(CFG_Region region)
{
switch (region)
{
default:
case CFG_REGION_JPN:
case CFG_REGION_USA:
case CFG_REGION_EUR:
case CFG_REGION_AUS:
return 0;
case CFG_REGION_CHN:
return 1;
case CFG_REGION_KOR:
return 2;
case CFG_REGION_TWN:
return 3;
}
}
static const char* const C2Di_FontPaths[] =
{
"font:/cbf_std.bcfnt.lz",
"font:/cbf_zh-Hans-CN.bcfnt.lz",
"font:/cbf_ko-Hang-KR.bcfnt.lz",
"font:/cbf_zh-Hant-TW.bcfnt.lz",
};
C2D_Font C2D_FontLoadSystem(CFG_Region region)
{
unsigned fontIdx = C2Di_RegionToFontIndex(region);
u8 systemRegion = 0;
Result rc = CFGU_SecureInfoGetRegion(&systemRegion);
if (R_FAILED(rc) || fontIdx == C2Di_RegionToFontIndex((CFG_Region)systemRegion))
{
fontEnsureMapped();
return NULL;
}
// Load the font
return C2Di_FontLoadFromArchive(0x0004009b00014002ULL | (fontIdx<<8), C2Di_FontPaths[fontIdx]);
}
void C2D_FontFree(C2D_Font font)
{
if (font)
{
if (font->cfnt)
linearFree(font->cfnt);
free(font->glyphSheets);
}
}
void C2D_FontSetFilter(C2D_Font font, GPU_TEXTURE_FILTER_PARAM magFilter, GPU_TEXTURE_FILTER_PARAM minFilter)
{
if (!font)
return;
TGLP_s* glyphInfo = font->cfnt->finf.tglp;
int i;
for (i = 0; i < glyphInfo->nSheets; i++)
{
C3D_Tex* tex = &font->glyphSheets[i];
C3D_TexSetFilter(tex, magFilter, minFilter);
}
}
int C2D_FontGlyphIndexFromCodePoint(C2D_Font font, u32 codepoint)
{
if (!font)
return fontGlyphIndexFromCodePoint(fontGetSystemFont(), codepoint);
else
return fontGlyphIndexFromCodePoint(font->cfnt, codepoint);
}
charWidthInfo_s* C2D_FontGetCharWidthInfo(C2D_Font font, int glyphIndex)
{
if (!font)
return fontGetCharWidthInfo(fontGetSystemFont(), glyphIndex);
else
return fontGetCharWidthInfo(font->cfnt, glyphIndex);
}
void C2D_FontCalcGlyphPos(C2D_Font font, fontGlyphPos_s* out, int glyphIndex, u32 flags, float scaleX, float scaleY)
{
if (!font)
fontCalcGlyphPos(out, fontGetSystemFont(), glyphIndex, flags, scaleX, scaleY);
else
fontCalcGlyphPos(out, font->cfnt, glyphIndex, flags, scaleX, scaleY);
}
FINF_s* C2D_FontGetInfo(C2D_Font font)
{
if (!font)
return fontGetInfo(NULL);
else
return fontGetInfo(font->cfnt);
}
================================================
FILE: source/internal.h
================================================
#pragma once
#include <c2d/base.h>
typedef struct
{
float pos[3];
float texcoord[2];
float ptcoord[2];
u32 color;
} C2Di_Vertex;
typedef struct
{
DVLB_s* shader;
shaderProgram_s program;
C3D_AttrInfo attrInfo;
C3D_BufInfo bufInfo;
C3D_ProcTex ptBlend;
C3D_ProcTex ptCircle;
C3D_ProcTexLut ptBlendLut;
C3D_ProcTexLut ptCircleLut;
u32 sceneW, sceneH;
C2Di_Vertex* vtxBuf;
u16* idxBuf;
size_t vtxBufSize;
size_t vtxBufPos;
size_t idxBufSize;
size_t idxBufPos;
size_t idxBufLastPos;
u32 flags;
C3D_Mtx projMtx;
C3D_Mtx mdlvMtx;
C3D_Tex* curTex;
u32 fadeClr;
} C2Di_Context;
enum
{
C2DiF_Active = BIT(0),
C2DiF_DirtyProj = BIT(1),
C2DiF_DirtyMdlv = BIT(2),
C2DiF_DirtyTex = BIT(3),
C2DiF_DirtyMode = BIT(4),
C2DiF_DirtyFade = BIT(5),
C2DiF_Mode_Shift = 8,
C2DiF_Mode_Mask = 0xf << C2DiF_Mode_Shift,
C2DiF_Mode_Solid = 0 << C2DiF_Mode_Shift,
C2DiF_Mode_Circle = 1 << C2DiF_Mode_Shift,
C2DiF_Mode_Text = 2 << C2DiF_Mode_Shift,
C2DiF_Mode_ImageSolid = 3 << C2DiF_Mode_Shift,
C2DiF_Mode_ImageMult = 4 << C2DiF_Mode_Shift,
C2DiF_Mode_ImageLuma = 5 << C2DiF_Mode_Shift,
C2DiF_Mode_ImageAdd = 6 << C2DiF_Mode_Shift,
C2DiF_Mode_ImageSub = 7 << C2DiF_Mode_Shift,
C2DiF_Mode_ImageOMAdd = 8 << C2DiF_Mode_Shift,
C2DiF_Mode_ImageOMSub = 9 << C2DiF_Mode_Shift,
C2DiF_ProcTex_Shift = 12,
C2DiF_ProcTex_Mask = 0xf << C2DiF_ProcTex_Shift,
C2DiF_ProcTex_None = 0 << C2DiF_ProcTex_Shift,
C2DiF_ProcTex_Blend = 1 << C2DiF_ProcTex_Shift,
C2DiF_ProcTex_Circle = 2 << C2DiF_ProcTex_Shift,
C2DiF_TintMode_Shift = 16,
C2DiF_TintMode_Mask = 0xf << C2DiF_TintMode_Shift,
C2DiF_DirtyAny = C2DiF_DirtyProj | C2DiF_DirtyMdlv | C2DiF_DirtyTex | C2DiF_DirtyMode | C2DiF_DirtyFade,
};
struct C2D_Font_s
{
CFNT_s* cfnt;
C3D_Tex* glyphSheets;
float textScale;
};
static inline C2Di_Context* C2Di_GetContext(void)
{
extern C2Di_Context __C2Di_Context;
return &__C2Di_Context;
}
static inline void C2Di_SetMode(u32 mode)
{
C2Di_Context* ctx = C2Di_GetContext();
mode &= C2DiF_Mode_Mask;
if ((ctx->flags & C2DiF_Mode_Mask) != mode)
ctx->flags = C2DiF_DirtyMode | (ctx->flags &~ C2DiF_Mode_Mask) | mode;
}
static inline void C2Di_SetTex(C3D_Tex* tex)
{
C2Di_Context* ctx = C2Di_GetContext();
if (tex != ctx->curTex)
{
ctx->flags |= C2DiF_DirtyTex;
ctx->curTex = tex;
}
}
typedef struct
{
float topLeft[2];
float topRight[2];
float botLeft[2];
float botRight[2];
} C2Di_Quad;
void C2Di_CalcQuad(C2Di_Quad* quad, const C2D_DrawParams* params);
void C2Di_AppendTri(void);
void C2Di_AppendQuad(void);
void C2Di_AppendVtx(float x, float y, float z, float u, float v, float ptx, float pty, u32 color);
void C2Di_FlushVtxBuf(void);
void C2Di_Update(void);
================================================
FILE: source/render2d.v.pica
================================================
; PICA200 vertex shader for citro2d
; Uniforms
.fvec mdlvMtx[4], projMtx[4]
; Constants
.constf common_const(0.0, 1.0, 0.5, 0.003921568393707275390625)
.alias zeros common_const.xxxx ; Vector full of 0.0
.alias ones common_const.yyyy ; Vector full of 1.0
.alias halves common_const.zzzz ; Vector full of 0.5
.alias clrdiv common_const.wwww ; Vector full of 1/255 (float24 approximation)
; Outputs
.out oPosition position
.out oTexCoord0 texcoord0
.out oTexCoord1 texcoord1
.out oColor color
; Inputs
.in iPosition v0
.in iTexCoord v1
.in iProcTexCoord v2
.in iColor v3
; Main procedure
.entry render2d_main
.proc render2d_main
; r0 = vec4(iPosition, 1.0)
mov r0.xyz, iPosition
mov r0.w, ones
; r1 = mdlvMtx * r0
dp4 r1.x, mdlvMtx[0], r0
dp4 r1.y, mdlvMtx[1], r0
dp4 r1.z, mdlvMtx[2], r0
dp4 r1.w, mdlvMtx[3], r0
; oPosition = projMtx * r1
dp4 oPosition.x, projMtx[0], r1
dp4 oPosition.y, projMtx[1], r1
dp4 oPosition.z, projMtx[2], r1
dp4 oPosition.w, projMtx[3], r1
; oTexCoord0 = iTexCoord
mov oTexCoord0, iTexCoord
; oTexCoord1 = iBlend
mov oTexCoord1, iProcTexCoord
; oColor = iColor / 255
mul oColor, clrdiv, iColor
end
.end
================================================
FILE: source/spritesheet.c
================================================
#include <stdio.h>
#include <stdlib.h>
#include "internal.h"
#include <c2d/spritesheet.h>
struct C2D_SpriteSheet_s
{
Tex3DS_Texture t3x;
C3D_Tex tex;
};
C2D_SpriteSheet C2D_SpriteSheetLoad(const char* filename)
{
FILE* f = fopen(filename, "rb");
if (!f) return NULL;
setvbuf(f, NULL, _IOFBF, 64*1024);
C2D_SpriteSheet ret = C2D_SpriteSheetLoadFromHandle(f);
fclose(f);
return ret;
}
static inline C2D_SpriteSheet C2Di_SpriteSheetAlloc(void)
{
return (C2D_SpriteSheet)malloc(sizeof(struct C2D_SpriteSheet_s));
}
static inline C2D_SpriteSheet C2Di_PostLoadSheet(C2D_SpriteSheet sheet)
{
if (!sheet->t3x)
{
free(sheet);
sheet = NULL;
} else
{
// Configure transparent border around texture
sheet->tex.border = 0;
C3D_TexSetWrap(&sheet->tex, GPU_CLAMP_TO_BORDER, GPU_CLAMP_TO_BORDER);
}
return sheet;
}
C2D_SpriteSheet C2D_SpriteSheetLoadFromMem(const void* data, size_t size)
{
C2D_SpriteSheet sheet = C2Di_SpriteSheetAlloc();
if (sheet)
{
sheet->t3x = Tex3DS_TextureImport(data, size, &sheet->tex, NULL, false);
sheet = C2Di_PostLoadSheet(sheet);
}
return sheet;
}
C2D_SpriteSheet C2D_SpriteSheetFromFD(int fd)
{
C2D_SpriteSheet sheet = C2Di_SpriteSheetAlloc();
if (sheet)
{
sheet->t3x = Tex3DS_TextureImportFD(fd, &sheet->tex, NULL, false);
sheet = C2Di_PostLoadSheet(sheet);
}
return sheet;
}
C2D_SpriteSheet C2D_SpriteSheetLoadFromHandle(FILE* f)
{
C2D_SpriteSheet sheet = C2Di_SpriteSheetAlloc();
if (sheet)
{
sheet->t3x = Tex3DS_TextureImportStdio(f, &sheet->tex, NULL, false);
sheet = C2Di_PostLoadSheet(sheet);
}
return sheet;
}
void C2D_SpriteSheetFree(C2D_SpriteSheet sheet)
{
Tex3DS_TextureFree(sheet->t3x);
C3D_TexDelete(&sheet->tex);
free(sheet);
}
size_t C2D_SpriteSheetCount(C2D_SpriteSheet sheet)
{
return Tex3DS_GetNumSubTextures(sheet->t3x);
}
C2D_Image C2D_SpriteSheetGetImage(C2D_SpriteSheet sheet, size_t index)
{
C2D_Image ret = { &sheet->tex, Tex3DS_GetSubTexture(sheet->t3x, index) };
return ret;
}
================================================
FILE: source/text.c
================================================
#include "internal.h"
#include <alloca.h>
#include <c2d/text.h>
#include <stdlib.h>
#include <stdarg.h>
static C3D_Tex* s_glyphSheets;
static float s_textScale;
typedef struct C2Di_Glyph_s
{
u32 lineNo;
C3D_Tex* sheet;
float xPos;
float width;
struct
{
float left, top, right, bottom;
} texcoord;
u32 wordNo;
} C2Di_Glyph;
struct C2D_TextBuf_s
{
u32 reserved[2];
size_t glyphCount;
size_t glyphBufSize;
C2Di_Glyph glyphs[0];
};
typedef struct C2Di_LineInfo_s
{
u32 words;
u32 wordStart;
} C2Di_LineInfo;
typedef struct C2Di_WordInfo_s
{
C2Di_Glyph* start;
C2Di_Glyph* end;
float wrapXOffset;
u32 newLineNumber;
} C2Di_WordInfo;
static size_t C2Di_TextBufBufferSize(size_t maxGlyphs)
{
return sizeof(struct C2D_TextBuf_s) + maxGlyphs*sizeof(C2Di_Glyph);
}
static int C2Di_GlyphComp(const void* _g1, const void* _g2)
{
const C2Di_Glyph* g1 = (C2Di_Glyph*)_g1;
const C2Di_Glyph* g2 = (C2Di_Glyph*)_g2;
int ret = (int)g1->sheet - (int)g2->sheet;
if (ret == 0)
ret = (int)g1 - (int)g2;
return ret;
}
static void C2Di_TextEnsureLoad(void)
{
// Skip if already loaded
if (s_glyphSheets)
return;
// Ensure the shared system font is mapped
if (R_FAILED(fontEnsureMapped()))
svcBreak(USERBREAK_PANIC);
// Load the glyph texture sheets
CFNT_s* font = fontGetSystemFont();
TGLP_s* glyphInfo = fontGetGlyphInfo(font);
s_glyphSheets = malloc(sizeof(C3D_Tex)*glyphInfo->nSheets);
s_textScale = 30.0f / glyphInfo->cellHeight;
if (!s_glyphSheets)
svcBreak(USERBREAK_PANIC);
int i;
for (i = 0; i < glyphInfo->nSheets; i ++)
{
C3D_Tex* tex = &s_glyphSheets[i];
tex->data = fontGetGlyphSheetTex(font, i);
tex->fmt = glyphInfo->sheetFmt;
tex->size = glyphInfo->sheetSize;
tex->width = glyphInfo->sheetWidth;
tex->height = glyphInfo->sheetHeight;
tex->param = GPU_TEXTURE_MAG_FILTER(GPU_LINEAR) | GPU_TEXTURE_MIN_FILTER(GPU_LINEAR)
| GPU_TEXTURE_WRAP_S(GPU_CLAMP_TO_BORDER) | GPU_TEXTURE_WRAP_T(GPU_CLAMP_TO_BORDER);
tex->border = 0;
tex->lodParam = 0;
}
}
C2D_TextBuf C2D_TextBufNew(size_t maxGlyphs)
{
C2Di_TextEnsureLoad();
C2D_TextBuf buf = (C2D_TextBuf)malloc(C2Di_TextBufBufferSize(maxGlyphs));
if (!buf) return NULL;
memset(buf, 0, sizeof(struct C2D_TextBuf_s));
buf->glyphBufSize = maxGlyphs;
return buf;
}
C2D_TextBuf C2D_TextBufResize(C2D_TextBuf buf, size_t maxGlyphs)
{
size_t oldMax = buf->glyphBufSize;
C2D_TextBuf newBuf = (C2D_TextBuf)realloc(buf, C2Di_TextBufBufferSize(maxGlyphs));
if (!newBuf) return NULL;
// zero out new glyphs
if (maxGlyphs > oldMax)
memset(&newBuf->glyphs[oldMax], 0, (maxGlyphs-oldMax)*sizeof(C2Di_Glyph));
newBuf->glyphBufSize = maxGlyphs;
return newBuf;
}
void C2D_TextBufDelete(C2D_TextBuf buf)
{
free(buf);
}
void C2D_TextBufClear(C2D_TextBuf buf)
{
buf->glyphCount = 0;
}
size_t C2D_TextBufGetNumGlyphs(C2D_TextBuf buf)
{
return buf->glyphCount;
}
const char* C2D_TextParseLine(C2D_Text* text, C2D_TextBuf buf, const char* str, u32 lineNo)
{
return C2D_TextFontParseLine(text, NULL, buf, str, lineNo);
}
const char* C2D_TextFontParseLine(C2D_Text* text, C2D_Font font, C2D_TextBuf buf, const char* str, u32 lineNo)
{
const uint8_t* p = (const uint8_t*)str;
text->font = font;
text->buf = buf;
text->begin = buf->glyphCount;
text->width = 0.0f;
u32 wordNum = 0;
bool lastWasWhitespace = true;
while (buf->glyphCount < buf->glyphBufSize)
{
uint32_t code;
ssize_t units = decode_utf8(&code, p);
if (units == -1)
{
code = 0xFFFD;
units = 1;
} else if (code == 0 || code == '\n')
{
break;
}
p += units;
fontGlyphPos_s glyphData;
C2D_FontCalcGlyphPos(font, &glyphData, C2D_FontGlyphIndexFromCodePoint(font, code), 0, 1.0f, 1.0f);
if (glyphData.width > 0.0f)
{
C2Di_Glyph* glyph = &buf->glyphs[buf->glyphCount++];
if (font)
glyph->sheet = &font->glyphSheets[glyphData.sheetIndex];
else
glyph->sheet = &s_glyphSheets[glyphData.sheetIndex];
glyph->xPos = text->width + glyphData.xOffset;
glyph->lineNo = lineNo;
glyph->wordNo = wordNum;
glyph->width = glyphData.width;
glyph->texcoord.left = glyphData.texcoord.left;
glyph->texcoord.top = glyphData.texcoord.top;
glyph->texcoord.right = glyphData.texcoord.right;
glyph->texcoord.bottom = glyphData.texcoord.bottom;
lastWasWhitespace = false;
}
else if (!lastWasWhitespace)
{
wordNum++;
lastWasWhitespace = true;
}
text->width += glyphData.xAdvance;
}
// If we last parsed non-whitespace, increment the word counter
if (!lastWasWhitespace)
wordNum++;
text->end = buf->glyphCount;
text->width *= font ? font->textScale : s_textScale;
text->lines = 1;
text->words = wordNum;
return (const char*)p;
}
const char* C2D_TextParse(C2D_Text* text, C2D_TextBuf buf, const char* str)
{
return C2D_TextFontParse(text, NULL, buf, str);
}
const char* C2D_TextFontParse(C2D_Text* text, C2D_Font font, C2D_TextBuf buf, const char* str)
{
text->font = font;
text->buf = buf;
text->begin = buf->glyphCount;
text->width = 0.0f;
text->words = 0;
text->lines = 0;
for (;;)
{
C2D_Text temp;
str = C2D_TextFontParseLine(&temp, font, buf, str, text->lines++);
text->words += temp.words;
if (temp.width > text->width)
text->width = temp.width;
if (!str || *str != '\n')
break;
str++;
}
text->end = buf->glyphCount;
return str;
}
void C2D_TextOptimize(const C2D_Text* text)
{
// Dirty and probably not very efficient/overkill, but it should work
qsort(&text->buf->glyphs[text->begin], text->end-text->begin, sizeof(C2Di_Glyph), C2Di_GlyphComp);
}
void C2D_TextGetDimensions(const C2D_Text* text, float scaleX, float scaleY, float* outWidth, float* outHeight)
{
if (outWidth)
*outWidth = scaleX*text->width;
if (outHeight)
{
if (text->font)
*outHeight = ceilf(scaleY*text->font->textScale*text->font->cfnt->finf.lineFeed)*text->lines;
else
*outHeight = ceilf(scaleY*s_textScale*fontGetInfo(fontGetSystemFont())->lineFeed)*text->lines;
}
}
static inline void C2Di_CalcLineInfo(const C2D_Text* text, C2Di_LineInfo* lines, C2Di_WordInfo* words)
{
C2Di_Glyph* begin = &text->buf->glyphs[text->begin];
C2Di_Glyph* end = &text->buf->glyphs[text->end];
C2Di_Glyph* cur;
// Get information about lines
memset(lines, 0, sizeof(C2Di_LineInfo) * text->lines);
for (cur = begin; cur != end; cur++)
if (cur->wordNo >= lines[cur->lineNo].words)
lines[cur->lineNo].words = cur->wordNo + 1;
for (u32 i = 1; i < text->lines; i++)
lines[i].wordStart = lines[i-1].wordStart + lines[i-1].words;
// Get information about words
for (u32 i = 0; i < text->words; i++)
{
words[i].start = NULL;
words[i].end = NULL;
words[i].wrapXOffset = 0;
words[i].newLineNumber = 0;
}
for (cur = begin; cur != end; cur++)
{
u32 consecutiveWordNum = cur->wordNo + lines[cur->lineNo].wordStart;
if (!words[consecutiveWordNum].end || cur->xPos + cur->width > words[consecutiveWordNum].end->xPos + words[consecutiveWordNum].end->width)
words[consecutiveWordNum].end = cur;
if (!words[consecutiveWordNum].start || cur->xPos < words[consecutiveWordNum].start->xPos)
words[consecutiveWordNum].start = cur;
words[consecutiveWordNum].newLineNumber = cur->lineNo;
}
}
static inline void C2Di_CalcLineWidths(float* widths, const C2D_Text* text, const C2Di_WordInfo* words, bool wrap)
{
u32 currentWord = 0;
if (words)
{
while (currentWord != text->words)
{
u32 nextLineWord = currentWord + 1;
// Advance nextLineWord to the next word that's on a different line, or the end
if (wrap)
{
while (nextLineWord != text->words && words[nextLineWord].newLineNumber == words[currentWord].newLineNumber) nextLineWord++;
// Finally, set the new line width
widths[words[currentWord].newLineNumber] = words[nextLineWord-1].end->xPos + words[nextLineWord-1].end->width - words[currentWord].start->xPos;
}
else
{
while (nextLineWord != text->words && words[nextLineWord].start->lineNo == words[currentWord].start->lineNo) nextLineWord++;
// Finally, set the new line width
widths[words[currentWord].start->lineNo] = words[nextLineWord-1].end->xPos + words[nextLineWord-1].end->width - words[currentWord].start->xPos;
}
currentWord = nextLineWord;
}
}
else
{
memset(widths, 0, sizeof(float) * text->lines);
for (C2Di_Glyph* cur = &text->buf->glyphs[text->begin]; cur != &text->buf->glyphs[text->end]; cur++)
if (cur->xPos + cur->width > widths[cur->lineNo])
widths[cur->lineNo] = cur->xPos + cur->width;
}
}
void C2D_DrawText(const C2D_Text* text, u32 flags, float x, float y, float z, float scaleX, float scaleY, ...)
{
// If there are no words, we can't do the math calculations necessary with them. Just return; nothing would be drawn anyway.
if (text->words == 0)
return;
C2Di_Glyph* begin = &text->buf->glyphs[text->begin];
C2Di_Glyph* end = &text->buf->glyphs[text->end];
C2Di_Glyph* cur;
CFNT_s* systemFont = fontGetSystemFont();
float glyphZ = z;
float glyphH;
float dispY;
if (text->font)
{
scaleX *= text->font->textScale;
scaleY *= text->font->textScale;
glyphH = scaleY*text->font->cfnt->finf.tglp->cellHeight;
dispY = ceilf(scaleY*text->font->cfnt->finf.lineFeed);
} else
{
scaleX *= s_textScale;
scaleY *= s_textScale;
glyphH = scaleY*fontGetGlyphInfo(systemFont)->cellHeight;
dispY = ceilf(scaleY*fontGetInfo(systemFont)->lineFeed);
}
u32 color = 0xFF000000;
float maxWidth = scaleX*text->width;
va_list va;
va_start(va, scaleY);
if (flags & C2D_AtBaseline)
{
if (text->font)
y -= scaleY*text->font->cfnt->finf.tglp->baselinePos;
else
y -= scaleY*fontGetGlyphInfo(systemFont)->baselinePos;
}
if (flags & C2D_WithColor)
color = va_arg(va, u32);
if (flags & C2D_WordWrap)
maxWidth = va_arg(va, double); // Passed as float, but varargs promotes to double.
va_end(va);
C2Di_SetMode(C2DiF_Mode_Text);
C2Di_LineInfo* lines = NULL;
C2Di_WordInfo* words = NULL;
if (flags & C2D_WordWrap)
{
lines = alloca(sizeof(*lines)*text->lines);
words = alloca(sizeof(*words)*text->words);
C2Di_CalcLineInfo(text, lines, words);
// The first word will never have a wrap offset in X or Y
for (u32 i = 1; i < text->words; i++)
{
// If the current word was originally on a different line than the last one, only the difference between new line number and original line number should be the same
if (words[i-1].start->lineNo != words[i].start->lineNo)
{
words[i].wrapXOffset = 0;
words[i].newLineNumber = words[i].start->lineNo + (words[i-1].newLineNumber - words[i-1].start->lineNo);
}
// Otherwise, if the current word goes over the width, with the previous word's offset taken into account...
else if (scaleX*(words[i-1].wrapXOffset + words[i].end->xPos + words[i].end->width) > maxWidth)
{
// Then set the X offset to the negative of the original position
words[i].wrapXOffset = -words[i].start->xPos;
// And set the new line number based off the last word's
words[i].newLineNumber = words[i-1].newLineNumber + 1;
}
// Otherwise both X offset and new line number should be the same as the last word's
else
{
words[i].wrapXOffset = words[i-1].wrapXOffset;
words[i].newLineNumber = words[i-1].newLineNumber;
}
}
}
switch (flags & C2D_AlignMask)
{
case C2D_AlignLeft:
for (cur = begin; cur != end; ++cur)
{
float glyphW = scaleX*cur->width;
float glyphX;
float glyphY;
if (flags & C2D_WordWrap)
{
u32 consecutiveWordNum = cur->wordNo + lines[cur->lineNo].wordStart;
glyphX = x+scaleX*(cur->xPos + words[consecutiveWordNum].wrapXOffset);
glyphY = y+dispY*words[consecutiveWordNum].newLineNumber;
}
else
{
glyphX = x+scaleX*cur->xPos;
glyphY = y+dispY*cur->lineNo;
}
C2Di_SetTex(cur->sheet);
C2Di_Update();
C2Di_AppendQuad();
C2Di_AppendVtx(glyphX, glyphY, glyphZ, cur->texcoord.left, cur->texcoord.top, 0.0f, 1.0f, color);
C2Di_AppendVtx(glyphX+glyphW, glyphY, glyphZ, cur->texcoord.right, cur->texcoord.top, 0.0f, 1.0f, color);
C2Di_AppendVtx(glyphX, glyphY+glyphH, glyphZ, cur->texcoord.left, cur->texcoord.bottom, 0.0f, 1.0f, color);
C2Di_AppendVtx(glyphX+glyphW, glyphY+glyphH, glyphZ, cur->texcoord.right, cur->texcoord.bottom, 0.0f, 1.0f, color);
}
break;
case C2D_AlignRight:
{
float finalLineWidths[flags & C2D_WordWrap ? words[text->words-1].newLineNumber + 1 : text->lines];
C2Di_CalcLineWidths(finalLineWidths, text, words, flags & C2D_WordWrap);
for (cur = begin; cur != end; cur++)
{
float glyphW = scaleX*cur->width;
float glyphX;
float glyphY;
if (flags & C2D_WordWrap)
{
u32 consecutiveWordNum = cur->wordNo + lines[cur->lineNo].wordStart;
glyphX = x + scaleX*(cur->xPos + words[consecutiveWordNum].wrapXOffset - finalLineWidths[words[consecutiveWordNum].newLineNumber]);
glyphY = y + dispY*words[consecutiveWordNum].newLineNumber;
}
else
{
glyphX = x + scaleX*(cur->xPos - finalLineWidths[cur->lineNo]);
glyphY = y + dispY*cur->lineNo;
}
C2Di_SetTex(cur->sheet);
C2Di_Update();
C2Di_AppendQuad();
C2Di_AppendVtx(glyphX, glyphY, glyphZ, cur->texcoord.left, cur->texcoord.top, 0.0f, 1.0f, color);
C2Di_AppendVtx(glyphX+glyphW, glyphY, glyphZ, cur->texcoord.right, cur->texcoord.top, 0.0f, 1.0f, color);
C2Di_AppendVtx(glyphX, glyphY+glyphH, glyphZ, cur->texcoord.left, cur->texcoord.bottom, 0.0f, 1.0f, color);
C2Di_AppendVtx(glyphX+glyphW, glyphY+glyphH, glyphZ, cur->texcoord.righ
gitextract_jjtyurv2/
├── .gitignore
├── CMakeLists.txt
├── Catnip.cmake
├── Changelog.md
├── Doxyfile
├── LICENSE
├── README.md
├── include/
│ ├── c2d/
│ │ ├── base.h
│ │ ├── font.h
│ │ ├── sprite.h
│ │ ├── spritesheet.h
│ │ └── text.h
│ └── citro2d.h
└── source/
├── base.c
├── font.c
├── internal.h
├── render2d.v.pica
├── spritesheet.c
└── text.c
SYMBOL INDEX (129 symbols across 10 files) FILE: include/c2d/base.h type C2D_DrawParams (line 19) | typedef struct type C2D_TintMode (line 35) | typedef enum type C2D_Tint (line 46) | typedef struct type C2D_Corner (line 52) | typedef enum type C2D_Image (line 60) | typedef struct type C2D_ImageTint (line 66) | typedef struct function C2D_CONSTEXPR (line 81) | C2D_CONSTEXPR float C2D_Clamp(float x, float min, float max) function C2D_CONSTEXPR (line 90) | C2D_CONSTEXPR u8 C2D_FloatToU8(float x) function C2D_CONSTEXPR (line 102) | C2D_CONSTEXPR u32 C2D_Color32(u8 r, u8 g, u8 b, u8 a) function C2D_CONSTEXPR (line 114) | C2D_CONSTEXPR u32 C2D_Color32f(float r, float g, float b, float a) function C2D_SetImageTint (line 125) | static inline void C2D_SetImageTint(C2D_ImageTint* tint, C2D_Corner corn... function C2D_PlainImageTint (line 136) | static inline void C2D_PlainImageTint(C2D_ImageTint* tint, u32 color, fl... function C2D_AlphaImageTint (line 148) | static inline void C2D_AlphaImageTint(C2D_ImageTint* tint, float alpha) function C2D_TopImageTint (line 158) | static inline void C2D_TopImageTint(C2D_ImageTint* tint, u32 color, floa... function C2D_BottomImageTint (line 169) | static inline void C2D_BottomImageTint(C2D_ImageTint* tint, u32 color, f... function C2D_LeftImageTint (line 180) | static inline void C2D_LeftImageTint(C2D_ImageTint* tint, u32 color, flo... function C2D_RightImageTint (line 191) | static inline void C2D_RightImageTint(C2D_ImageTint* tint, u32 color, fl... function C2D_SceneTarget (line 231) | static inline void C2D_SceneTarget(C3D_RenderTarget* target) function C2D_ViewRotateDegrees (line 263) | static inline void C2D_ViewRotateDegrees(float rotation) function C2D_SceneBegin (line 296) | static inline void C2D_SceneBegin(C3D_RenderTarget* target) function C2D_DrawImageAt (line 350) | static inline bool C2D_DrawImageAt(C2D_Image img, float x, float y, floa... function C2D_DrawImageAtRotated (line 373) | static inline bool C2D_DrawImageAtRotated(C2D_Image img, float x, float ... function C2D_DrawRectSolid (line 442) | static inline bool C2D_DrawRectSolid( function C2D_DrawEllipseSolid (line 474) | static inline bool C2D_DrawEllipseSolid( function C2D_DrawCircle (line 492) | static inline bool C2D_DrawCircle( function C2D_DrawCircleSolid (line 509) | static inline bool C2D_DrawCircleSolid( FILE: include/c2d/font.h type C2D_Font_s (line 8) | struct C2D_Font_s type C2D_Font_s (line 9) | struct C2D_Font_s FILE: include/c2d/sprite.h type C2D_Sprite (line 8) | typedef struct function C2D_SpriteFromImage (line 22) | static inline void C2D_SpriteFromImage(C2D_Sprite* sprite, C2D_Image image) function C2D_SpriteFromSheet (line 40) | static inline void C2D_SpriteFromSheet(C2D_Sprite* sprite, C2D_SpriteShe... function C2D_SpriteScale (line 50) | static inline void C2D_SpriteScale(C2D_Sprite* sprite, float x, float y) function C2D_SpriteRotate (line 62) | static inline void C2D_SpriteRotate(C2D_Sprite* sprite, float radians) function C2D_SpriteRotateDegrees (line 71) | static inline void C2D_SpriteRotateDegrees(C2D_Sprite* sprite, float deg... function C2D_SpriteMove (line 81) | static inline void C2D_SpriteMove(C2D_Sprite* sprite, float x, float y) function C2D_SpriteSetScale (line 92) | static inline void C2D_SpriteSetScale(C2D_Sprite* sprite, float x, float y) function C2D_SpriteSetRotation (line 106) | static inline void C2D_SpriteSetRotation(C2D_Sprite* sprite, float radians) function C2D_SpriteSetRotationDegrees (line 115) | static inline void C2D_SpriteSetRotationDegrees(C2D_Sprite* sprite, floa... function C2D_SpriteSetCenter (line 125) | static inline void C2D_SpriteSetCenter(C2D_Sprite* sprite, float x, floa... function C2D_SpriteSetCenterRaw (line 136) | static inline void C2D_SpriteSetCenterRaw(C2D_Sprite* sprite, float x, f... function C2D_SpriteSetPos (line 147) | static inline void C2D_SpriteSetPos(C2D_Sprite* sprite, float x, float y) function C2D_SpriteSetDepth (line 157) | static inline void C2D_SpriteSetDepth(C2D_Sprite* sprite, float depth) function C2D_DrawSprite (line 165) | static inline bool C2D_DrawSprite(const C2D_Sprite* sprite) function C2D_DrawSpriteTinted (line 174) | static inline bool C2D_DrawSpriteTinted(const C2D_Sprite* sprite, const ... FILE: include/c2d/spritesheet.h type C2D_SpriteSheet_s (line 8) | struct C2D_SpriteSheet_s type C2D_SpriteSheet_s (line 9) | struct C2D_SpriteSheet_s FILE: include/c2d/text.h type C2D_TextBuf_s (line 9) | struct C2D_TextBuf_s type C2D_TextBuf_s (line 10) | struct C2D_TextBuf_s type C2D_Text (line 17) | typedef struct FILE: source/base.c function C2Di_CheckBufSpace (line 8) | static inline bool C2Di_CheckBufSpace(C2Di_Context* ctx, unsigned idx, u... function C2Di_FrameEndHook (line 15) | static void C2Di_FrameEndHook(void* unused) function C2D_Init (line 24) | bool C2D_Init(size_t maxObjects) function C2D_Fini (line 105) | void C2D_Fini(void) function C2D_Prepare (line 119) | void C2D_Prepare(void) function C2D_Flush (line 158) | void C2D_Flush(void) function C2D_SceneSize (line 167) | void C2D_SceneSize(u32 width, u32 height, bool tilt) function C2D_ViewReset (line 203) | void C2D_ViewReset(void) function C2D_ViewSave (line 213) | void C2D_ViewSave(C3D_Mtx* matrix) function C2D_ViewRestore (line 219) | void C2D_ViewRestore(const C3D_Mtx* matrix) function C2D_ViewTranslate (line 229) | void C2D_ViewTranslate(float x, float y) function C2D_ViewRotate (line 239) | void C2D_ViewRotate(float radians) function C2D_ViewShear (line 249) | void C2D_ViewShear(float x, float y) function C2D_ViewScale (line 263) | void C2D_ViewScale(float x, float y) function C3D_RenderTarget (line 273) | C3D_RenderTarget* C2D_CreateScreenTarget(gfxScreen_t screen, gfx3dSide_t... function C2D_TargetClear (line 295) | void C2D_TargetClear(C3D_RenderTarget* target, u32 color) function C2D_Fade (line 302) | bool C2D_Fade(u32 color) function C2D_SetTintMode (line 313) | bool C2D_SetTintMode(C2D_TintMode mode) function C2Di_RotatePoint (line 350) | static inline void C2Di_RotatePoint(float* point, float rsin, float rcos) function C2Di_SwapUV (line 358) | static inline void C2Di_SwapUV(float* a, float* b) function C2Di_CalcQuad (line 367) | void C2Di_CalcQuad(C2Di_Quad* quad, const C2D_DrawParams* params) function C2D_DrawImage (line 401) | bool C2D_DrawImage(C2D_Image img, const C2D_DrawParams* params, const C2... function C2D_DrawTriangle (line 451) | bool C2D_DrawTriangle(float x0, float y0, u32 clr0, float x1, float y1, ... function C2D_DrawLine (line 469) | bool C2D_DrawLine(float x0, float y0, u32 clr0, float x1, float y1, u32 ... function C2D_DrawRectangle (line 492) | bool C2D_DrawRectangle(float x, float y, float z, float w, float h, u32 ... function C2D_DrawEllipse (line 511) | bool C2D_DrawEllipse(float x, float y, float z, float w, float h, u32 cl... function C2Di_AppendTri (line 530) | void C2Di_AppendTri(void) function C2Di_AppendQuad (line 541) | void C2Di_AppendQuad(void) function C2Di_AppendVtx (line 555) | void C2Di_AppendVtx(float x, float y, float z, float u, float v, float p... function C2Di_FlushVtxBuf (line 569) | void C2Di_FlushVtxBuf(void) function C2Di_Update (line 578) | void C2Di_Update(void) FILE: source/font.c function C2D_Font (line 7) | C2D_Font C2D_FontLoad(const char* filename) function C2D_Font (line 16) | static inline C2D_Font C2Di_FontAlloc(void) function C2D_Font (line 21) | static C2D_Font C2Di_PostLoadFont(C2D_Font font) function C2D_Font (line 58) | C2D_Font C2D_FontLoadFromMem(const void* data, size_t size) function C2D_Font (line 71) | C2D_Font C2D_FontLoadFromFD(int fd) function C2D_Font (line 89) | C2D_Font C2D_FontLoadFromHandle(FILE* handle) function C2D_Font (line 107) | static C2D_Font C2Di_FontLoadFromArchive(u64 tid, const char* path) function C2Di_RegionToFontIndex (line 154) | static unsigned C2Di_RegionToFontIndex(CFG_Region region) function C2D_Font (line 181) | C2D_Font C2D_FontLoadSystem(CFG_Region region) function C2D_FontFree (line 197) | void C2D_FontFree(C2D_Font font) function C2D_FontSetFilter (line 207) | void C2D_FontSetFilter(C2D_Font font, GPU_TEXTURE_FILTER_PARAM magFilter... function C2D_FontGlyphIndexFromCodePoint (line 222) | int C2D_FontGlyphIndexFromCodePoint(C2D_Font font, u32 codepoint) function charWidthInfo_s (line 230) | charWidthInfo_s* C2D_FontGetCharWidthInfo(C2D_Font font, int glyphIndex) function C2D_FontCalcGlyphPos (line 238) | void C2D_FontCalcGlyphPos(C2D_Font font, fontGlyphPos_s* out, int glyphI... function FINF_s (line 246) | FINF_s* C2D_FontGetInfo(C2D_Font font) FILE: source/internal.h type C2Di_Vertex (line 4) | typedef struct type C2Di_Context (line 12) | typedef struct type C2D_Font_s (line 75) | struct C2D_Font_s function C2Di_Context (line 82) | static inline C2Di_Context* C2Di_GetContext(void) function C2Di_SetMode (line 88) | static inline void C2Di_SetMode(u32 mode) function C2Di_SetTex (line 96) | static inline void C2Di_SetTex(C3D_Tex* tex) type C2Di_Quad (line 106) | typedef struct FILE: source/spritesheet.c type C2D_SpriteSheet_s (line 6) | struct C2D_SpriteSheet_s function C2D_SpriteSheet (line 12) | C2D_SpriteSheet C2D_SpriteSheetLoad(const char* filename) function C2D_SpriteSheet (line 22) | static inline C2D_SpriteSheet C2Di_SpriteSheetAlloc(void) function C2D_SpriteSheet (line 27) | static inline C2D_SpriteSheet C2Di_PostLoadSheet(C2D_SpriteSheet sheet) function C2D_SpriteSheet (line 42) | C2D_SpriteSheet C2D_SpriteSheetLoadFromMem(const void* data, size_t size) function C2D_SpriteSheet (line 53) | C2D_SpriteSheet C2D_SpriteSheetFromFD(int fd) function C2D_SpriteSheet (line 64) | C2D_SpriteSheet C2D_SpriteSheetLoadFromHandle(FILE* f) function C2D_SpriteSheetFree (line 75) | void C2D_SpriteSheetFree(C2D_SpriteSheet sheet) function C2D_SpriteSheetCount (line 82) | size_t C2D_SpriteSheetCount(C2D_SpriteSheet sheet) function C2D_Image (line 87) | C2D_Image C2D_SpriteSheetGetImage(C2D_SpriteSheet sheet, size_t index) FILE: source/text.c type C2Di_Glyph (line 10) | typedef struct C2Di_Glyph_s type C2D_TextBuf_s (line 23) | struct C2D_TextBuf_s type C2Di_LineInfo (line 31) | typedef struct C2Di_LineInfo_s type C2Di_WordInfo (line 37) | typedef struct C2Di_WordInfo_s function C2Di_TextBufBufferSize (line 45) | static size_t C2Di_TextBufBufferSize(size_t maxGlyphs) function C2Di_GlyphComp (line 50) | static int C2Di_GlyphComp(const void* _g1, const void* _g2) function C2Di_TextEnsureLoad (line 60) | static void C2Di_TextEnsureLoad(void) function C2D_TextBuf (line 94) | C2D_TextBuf C2D_TextBufNew(size_t maxGlyphs) function C2D_TextBuf (line 105) | C2D_TextBuf C2D_TextBufResize(C2D_TextBuf buf, size_t maxGlyphs) function C2D_TextBufDelete (line 120) | void C2D_TextBufDelete(C2D_TextBuf buf) function C2D_TextBufClear (line 125) | void C2D_TextBufClear(C2D_TextBuf buf) function C2D_TextBufGetNumGlyphs (line 130) | size_t C2D_TextBufGetNumGlyphs(C2D_TextBuf buf) function C2D_TextOptimize (line 231) | void C2D_TextOptimize(const C2D_Text* text) function C2D_TextGetDimensions (line 237) | void C2D_TextGetDimensions(const C2D_Text* text, float scaleX, float sca... function C2Di_CalcLineInfo (line 250) | static inline void C2Di_CalcLineInfo(const C2D_Text* text, C2Di_LineInfo... function C2Di_CalcLineWidths (line 282) | static inline void C2Di_CalcLineWidths(float* widths, const C2D_Text* te... function C2D_DrawText (line 316) | void C2D_DrawText(const C2D_Text* text, u32 flags, float x, float y, flo...
Condensed preview — 19 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (212K chars).
[
{
"path": ".gitignore",
"chars": 109,
"preview": "*~\n*.3dsx\n*.elf\n*.exe\n*.smdh\n*.gz\n*.bz2\n*.xz\nThumbs.db\nbuild/\ndeps/\nrelease/\ndebug/\nlib/\nbin/\ndocs/\n.vscode/\n"
},
{
"path": "CMakeLists.txt",
"chars": 1019,
"preview": "cmake_minimum_required(VERSION 3.13)\n\nproject(citro2d\n\tLANGUAGES C ASM\n)\n\ninclude(GNUInstallDirs)\n\nif(CMAKE_INSTALL_PREF"
},
{
"path": "Catnip.cmake",
"chars": 151,
"preview": "catnip_package(citro2d DEFAULT all)\n\ncatnip_add_preset(release TOOLSET 3DS BUILD_TYPE Release)\ncatnip_add_preset(debug "
},
{
"path": "Changelog.md",
"chars": 1705,
"preview": "# Changelog\n\n## Version 1.6.0\n\n- Added C2D_SetTintMode: switchable tinting modes (solid tint/multiplicative tint/graysca"
},
{
"path": "Doxyfile",
"chars": 105309,
"preview": "# Doxyfile 1.8.11\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org)"
},
{
"path": "LICENSE",
"chars": 853,
"preview": "Copyright (C) 2017-2018 fincs\n\nThis software is provided 'as-is', without any express or implied\nwarranty. In no event "
},
{
"path": "README.md",
"chars": 1247,
"preview": "# citro2d\n\n**( ͡° ͜ʖ ͡°)**\n\n*Library for drawing 2D graphics using the Nintendo 3DS's PICA200 GPU.*\n\nThis library contai"
},
{
"path": "include/c2d/base.h",
"chars": 19925,
"preview": "/**\n * @file base.h\n * @brief Basic citro2d initialization and drawing API\n */\n#pragma once\n#include <citro3d.h>\n#includ"
},
{
"path": "include/c2d/font.h",
"chars": 2904,
"preview": "/**\n * @file font.h\n * @brief Font loading and management\n */\n#pragma once\n#include \"base.h\"\n\nstruct C2D_Font_s;\ntypedef"
},
{
"path": "include/c2d/sprite.h",
"chars": 5440,
"preview": "/**\n * @file sprite.h\n * @brief Stateful sprite API\n */\n#pragma once\n#include \"spritesheet.h\"\n\ntypedef struct\n{\n\tC2D_Ima"
},
{
"path": "include/c2d/spritesheet.h",
"chars": 1775,
"preview": "/**\n * @file spritesheet.h\n * @brief Spritesheet (texture atlas) loading and management\n */\n#pragma once\n#include \"base."
},
{
"path": "include/c2d/text.h",
"chars": 7739,
"preview": "/**\n * @file text.h\n * @brief Text rendering API\n */\n#pragma once\n#include \"base.h\"\n#include \"font.h\"\n\nstruct C2D_TextBu"
},
{
"path": "include/citro2d.h",
"chars": 420,
"preview": "/**\n * @file citro2d.h\n * @brief Central citro2d header. Includes all others.\n */\n#pragma once\n\n#ifdef CITRO2D_BUILD\n#er"
},
{
"path": "source/base.c",
"chars": 24007,
"preview": "#include \"internal.h\"\n#include \"render2d_shbin.h\"\n\nC2Di_Context __C2Di_Context;\nstatic C3D_Mtx s_projTop, s_projBot;\nsta"
},
{
"path": "source/font.c",
"chars": 5447,
"preview": "#include <stdio.h>\n#include <stdlib.h>\n#include <unistd.h>\n#include \"internal.h\"\n#include <c2d/font.h>\n\nC2D_Font C2D_Fon"
},
{
"path": "source/internal.h",
"chars": 2783,
"preview": "#pragma once\n#include <c2d/base.h>\n\ntypedef struct\n{\n\tfloat pos[3];\n\tfloat texcoord[2];\n\tfloat ptcoord[2];\n\tu32 color;\n}"
},
{
"path": "source/render2d.v.pica",
"chars": 1194,
"preview": "; PICA200 vertex shader for citro2d\n\n; Uniforms\n.fvec mdlvMtx[4], projMtx[4]\n\n; Constants\n.constf common_const(0.0, 1.0,"
},
{
"path": "source/spritesheet.c",
"chars": 1995,
"preview": "#include <stdio.h>\n#include <stdlib.h>\n#include \"internal.h\"\n#include <c2d/spritesheet.h>\n\nstruct C2D_SpriteSheet_s\n{\n\tT"
},
{
"path": "source/text.c",
"chars": 18455,
"preview": "#include \"internal.h\"\n#include <alloca.h>\n#include <c2d/text.h>\n#include <stdlib.h>\n#include <stdarg.h>\n\nstatic C3D_Tex*"
}
]
About this extraction
This page contains the full source code of the devkitPro/citro2d GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 19 files (197.7 KB), approximately 56.9k tokens, and a symbol index with 129 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.