libtcod
Loading...
Searching...
No Matches
context_viewport.h
Go to the documentation of this file.
1
/* BSD 3-Clause License
2
*
3
* Copyright © 2008-2025, Jice and the libtcod contributors.
4
* All rights reserved.
5
*
6
* Redistribution and use in source and binary forms, with or without
7
* modification, are permitted provided that the following conditions are met:
8
*
9
* 1. Redistributions of source code must retain the above copyright notice,
10
* this list of conditions and the following disclaimer.
11
*
12
* 2. Redistributions in binary form must reproduce the above copyright notice,
13
* this list of conditions and the following disclaimer in the documentation
14
* and/or other materials provided with the distribution.
15
*
16
* 3. Neither the name of the copyright holder nor the names of its
17
* contributors may be used to endorse or promote products derived from
18
* this software without specific prior written permission.
19
*
20
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30
* POSSIBILITY OF SUCH DAMAGE.
31
*/
34
#pragma once
35
#ifndef LIBTCOD_CONTEXT_VIEWPORT_H_
36
#define LIBTCOD_CONTEXT_VIEWPORT_H_
37
38
#include <stdbool.h>
39
40
#include "
color.h
"
41
48
struct
TCOD_ViewportOptions
{
52
int
tcod_version
;
61
bool
keep_aspect
;
67
bool
integer_scaling
;
71
TCOD_ColorRGBA
clear_color
;
79
float
align_x
;
80
float
align_y;
81
};
82
typedef
struct
TCOD_ViewportOptions
TCOD_ViewportOptions
;
86
extern
const
struct
TCOD_ViewportOptions
TCOD_VIEWPORT_DEFAULT_;
87
#ifdef __cplusplus
88
extern
"C"
{
89
#endif
// __cplusplus
99
TCOD_PUBLIC TCOD_NODISCARD
TCOD_ViewportOptions
*
TCOD_viewport_new
(
void
);
106
TCOD_PUBLIC
void
TCOD_viewport_delete
(
TCOD_ViewportOptions
* viewport);
107
#ifdef __cplusplus
108
}
// extern "C"
109
#endif
// __cplusplus
110
#endif
// LIBTCOD_CONTEXT_VIEWPORT_H_
color.h
Color handling module.
TCOD_viewport_new
TCOD_ViewportOptions * TCOD_viewport_new(void)
Allocate a new viewport options struct.
TCOD_viewport_delete
void TCOD_viewport_delete(TCOD_ViewportOptions *viewport)
Delete a viewport.
TCOD_ColorRGBA
A 4-channel RGBA color struct.
Definition
color.h:92
TCOD_ViewportOptions
Viewport options for the rendering context.
Definition
context_viewport.h:48
TCOD_ViewportOptions::tcod_version
int tcod_version
Must be set to TCOD_COMPILEDVERSION.
Definition
context_viewport.h:52
TCOD_ViewportOptions::keep_aspect
bool keep_aspect
If true then the aspect ratio will be kept square when the console is scaled.
Definition
context_viewport.h:61
TCOD_ViewportOptions::align_x
float align_x
Alignment of the console when it is letter-boxed: 0.0f renders the console in the upper-left corner,...
Definition
context_viewport.h:79
TCOD_ViewportOptions::clear_color
TCOD_ColorRGBA clear_color
The color to clear the screen with before rendering the console.
Definition
context_viewport.h:71
TCOD_ViewportOptions::integer_scaling
bool integer_scaling
If true then console scaling will be fixed to integer increments.
Definition
context_viewport.h:67
src
libtcod
context_viewport.h
Generated by
1.15.0