commonMain.shaders.annotations.Attribute.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020-2021 Slawomir Czerwinski
 *
 * 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 graphics.glimpse.shaders.annotations

/**
 * Vertex attributes array provided to a shader from the [mesh][graphics.glimpse.meshes.Mesh].
 *
 * This annotation is only intended to by used as an array element in [ShaderParams.attributes].
 */
@Target
@Retention(AnnotationRetention.SOURCE)
@MustBeDocumented
annotation class Attribute(

    /**
     * Attribute name.
     */
    val name: String,

    /**
     * Attribute role.
     *
     * Determines which buffer should be used with the attribute.
     */
    val role: AttributeRole,

    /**
     * Vertex attributes array vector size.
     */
    val vectorSize: Int
)