-
Notifications
You must be signed in to change notification settings - Fork 2
/
FrameBuffer.kt
75 lines (62 loc) · 1.81 KB
/
FrameBuffer.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
* Copyright (C) 2017 Social Apps BVBA
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package me.frontback.gpueffect.common
/**
* Interface to abstract the
*/
interface FrameBuffer : Input {
/**
* Initialize the frame buffer
* @param width width of the frame buffer
* *
* @param height height of the frame buffer
* *
* @return the FrameBuffer ID
* *
* @throws IllegalStateException when the frame buffer couldn't be initialized correctly
* @throws IllegalArgumentException when the width or height are < 1
*/
fun init(width: Int, height: Int): Int
/**
* Get if the frame buffer was initialized
* @return whether or not the frame buffer has been initialized
*/
val isInitialized: Boolean
/**
* Destroy the FrameBuffer
*/
override fun destroy()
/**
* Get the frame buffer ID
* @return the frame buffer ID
* *
* @throws IllegalStateException when the frame buffer is not initialized
*/
val id: Int
/**
* Get the attached texture
* @return the Texture object in which the frame buffer draws
*/
override val texture: Texture
/**
* Texture's initialization width
*/
val width: Int
/**
* Texture's initialization height
*/
val height: Int
}